[Python-checkins] gh-101100: Fix sphinx warnings in `zipapp` and `zipfile` modules (#102526)
AlexWaygood
webhook-mailer at python.org
Wed Mar 8 03:19:32 EST 2023
https://github.com/python/cpython/commit/1f557f94c2ee98c2a43bd090a7bf3f39a22ed874
commit: 1f557f94c2ee98c2a43bd090a7bf3f39a22ed874
branch: main
author: Nikita Sobolev <mail at sobolevn.me>
committer: AlexWaygood <Alex.Waygood at Gmail.com>
date: 2023-03-08T08:19:05Z
summary:
gh-101100: Fix sphinx warnings in `zipapp` and `zipfile` modules (#102526)
files:
M Doc/library/zipapp.rst
M Doc/library/zipfile.rst
diff --git a/Doc/library/zipapp.rst b/Doc/library/zipapp.rst
index fb40a2b3e964..981020b13cd9 100644
--- a/Doc/library/zipapp.rst
+++ b/Doc/library/zipapp.rst
@@ -215,7 +215,7 @@ using the :func:`create_archive` function::
>>> import zipapp
>>> zipapp.create_archive('old_archive.pyz', 'new_archive.pyz', '/usr/bin/python3')
-To update the file in place, do the replacement in memory using a :class:`BytesIO`
+To update the file in place, do the replacement in memory using a :class:`~io.BytesIO`
object, and then overwrite the source afterwards. Note that there is a risk
when overwriting a file in place that an error will result in the loss of
the original file. This code does not protect against such errors, but
diff --git a/Doc/library/zipfile.rst b/Doc/library/zipfile.rst
index 0195abc3a992..e2a085d6e98e 100644
--- a/Doc/library/zipfile.rst
+++ b/Doc/library/zipfile.rst
@@ -288,7 +288,7 @@ ZipFile Objects
(``ZipExtFile``) is read-only and provides the following methods:
:meth:`~io.BufferedIOBase.read`, :meth:`~io.IOBase.readline`,
:meth:`~io.IOBase.readlines`, :meth:`~io.IOBase.seek`,
- :meth:`~io.IOBase.tell`, :meth:`__iter__`, :meth:`~iterator.__next__`.
+ :meth:`~io.IOBase.tell`, :meth:`~container.__iter__`, :meth:`~iterator.__next__`.
These objects can operate independently of the ZipFile.
With ``mode='w'``, a writable file handle is returned, which supports the
More information about the Python-checkins
mailing list