[Python-checkins] (no subject)

[Łukasz Langa]

To: python-checkins at python.org
Subject: bpo-37408: Precise that Tarfile "format" argument only concerns
 writing. (GH-14389) (#16465)
Content-Type: text/plain; charset="utf-8"
Content-Transfer-Encoding: quoted-printable
MIME-Version: 1.0

https://github.com/python/cpython/commit/1aeb720d64021e544043ca4619a44a7da0cd=
00dd
commit: 1aeb720d64021e544043ca4619a44a7da0cd00dd
branch: 3.8
author: Miss Islington (bot) <31488909+miss-islington at users.noreply.github.co=
m>
committer: =C5=81ukasz Langa <lukasz at langa.pl>
date: 2019-09-30T09:06:28+02:00
summary:

bpo-37408: Precise that Tarfile "format" argument only concerns writing. (GH-=
14389) (#16465)

(cherry picked from commit c5a7e0ce194c0eafe82eb3e431881012398e7d46)

Co-authored-by: Pascal Chambon <pythoniks at gmail.com>

files:
M Doc/library/tarfile.rst

diff --git a/Doc/library/tarfile.rst b/Doc/library/tarfile.rst
index f25af8ca6a33..c34f2c4a5702 100644
--- a/Doc/library/tarfile.rst
+++ b/Doc/library/tarfile.rst
@@ -290,9 +290,10 @@ be finalized; only the internally used file object will =
be closed. See the
=20
       *fileobj* is not closed, when :class:`TarFile` is closed.
=20
-   *format* controls the archive format. It must be one of the constants
+   *format* controls the archive format for writing. It must be one of the c=
onstants
    :const:`USTAR_FORMAT`, :const:`GNU_FORMAT` or :const:`PAX_FORMAT` that are
-   defined at module level.
+   defined at module level. When reading, format will be automatically detec=
ted, even
+   if different formats are present in a single archive.
=20
    The *tarinfo* argument can be used to replace the default :class:`TarInfo=
` class
    with a different one.