From: Pascal Chambon <pythoniks@gmail.com>
Date: Sat, 28 Sep 2019 15:04:44 +0000 (+0200)
Subject: bpo-37408: Precise that Tarfile "format" argument only concerns writing. (GH-14389)
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=c5a7e0ce194c0eafe82eb3e431881012398e7d46;p=python

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

diff --git a/Doc/library/tarfile.rst b/Doc/library/tarfile.rst
index f25af8ca6a..c34f2c4a57 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
 
       *fileobj* is not closed, when :class:`TarFile` is closed.
 
-   *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 constants
    :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 detected, even
+   if different formats are present in a single archive.
 
    The *tarinfo* argument can be used to replace the default :class:`TarInfo` class
    with a different one.