[Python-checkins] r53753 - python/branches/release25-maint/Doc/lib/libtarfile.tex

[lars.gustaebel]

Author: lars.gustaebel
Date: Mon Feb 12 10:27:10 2007
New Revision: 53753

Modified:
   python/branches/release25-maint/Doc/lib/libtarfile.tex
Log:
Bug #1656581: Point out that external file objects are supposed to be
at position 0. (backport from rev. 53752)


Modified: python/branches/release25-maint/Doc/lib/libtarfile.tex
==============================================================================
--- python/branches/release25-maint/Doc/lib/libtarfile.tex	(original)
+++ python/branches/release25-maint/Doc/lib/libtarfile.tex	Mon Feb 12 10:27:10 2007
@@ -48,8 +48,8 @@
     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
@@ -155,6 +155,7 @@
 
     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}