]> granicus.if.org Git - python/commitdiff
Bug #1656581: Point out that external file objects are supposed to be
authorLars Gustäbel <lars@gustaebel.de>
Mon, 12 Feb 2007 09:25:53 +0000 (09:25 +0000)
committerLars Gustäbel <lars@gustaebel.de>
Mon, 12 Feb 2007 09:25:53 +0000 (09:25 +0000)
at position 0.

Doc/lib/libtarfile.tex

index 1a53a27e76ac67901d41d9049302e7a186d9fa7f..96f835f539569ea6f09c38c4f4c600e4428de8ba 100644 (file)
@@ -49,8 +49,8 @@ Some facts and figures:
     avoid this.  If a compression method is not supported,
     \exception{CompressionError} is raised.
 
-    If \var{fileobj} is specified, it is used as an alternative to
-    a file object opened for \var{name}.
+    If \var{fileobj} is specified, it is used as an alternative to a file
+    object opened for \var{name}. It is supposed to be at position 0.
 
     For special purposes, there is a second format for \var{mode}:
     \code{'filemode|[compression]'}.  \function{open()} will return a
@@ -161,6 +161,7 @@ tar archive several times. Each archive member is represented by a
 
     If \var{fileobj} is given, it is used for reading or writing data.
     If it can be determined, \var{mode} is overridden by \var{fileobj}'s mode.
+    \var{fileobj} will be used from position 0.
     \begin{notice}
         \var{fileobj} is not closed, when \class{TarFile} is closed.
     \end{notice}