From: Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com> Date: Wed, 8 Mar 2023 08:44:34 +0000 (-0800) Subject: gh-101100: Fix sphinx warnings in `zipapp` and `zipfile` modules (GH-102526) X-Git-Tag: v3.10.11~49 X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=7276ee0d122d072486b4a9fc03d17533f871da8f;p=thirdparty%2FPython%2Fcpython.git gh-101100: Fix sphinx warnings in `zipapp` and `zipfile` modules (GH-102526) (cherry picked from commit 1f557f94c2ee98c2a43bd090a7bf3f39a22ed874) Co-authored-by: Nikita Sobolev --- 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 5072daa63354..78556851d351 100644 --- a/Doc/library/zipfile.rst +++ b/Doc/library/zipfile.rst @@ -266,7 +266,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