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

c5a7e0ce · Pascal Chambon · Gregory P. Smith · c8165036 · c5a7e0ce
Commit c5a7e0ce authored Sep 28, 2019 by Pascal Chambon Committed by Gregory P. Smith Sep 28, 2019
Hide whitespace changes
Inline Side-by-side

Showing with 3 additions and 2 deletions

Doc/library/tarfile.rst Doc/library/tarfile.rst +3 -2

No files found.
--- 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.