]> granicus.if.org Git - python/commitdiff
Update docstring for BZ2File.__init__().
authorNadeem Vawda <nadeem.vawda@gmail.com>
Sat, 4 Feb 2012 11:08:11 +0000 (13:08 +0200)
committerNadeem Vawda <nadeem.vawda@gmail.com>
Sat, 4 Feb 2012 11:08:11 +0000 (13:08 +0200)
Lib/bz2.py

index 36e55584ed7b656b31300110d5f7a1c0157ec48c..5c228f95e5a7665479ce974866755ea5c364c0a8 100644 (file)
@@ -47,13 +47,17 @@ class BZ2File(io.BufferedIOBase):
         the file object given by fileobj. Exactly one of these two
         parameters should be provided.
 
-        mode can be 'r' for reading (default), or 'w' for writing.
+        mode can be 'r' for reading (default), 'w' for (over)writing, or
+        'a' for appending.
 
         buffering is ignored. Its use is deprecated.
 
-        If mode is 'w', compresslevel can be a number between 1 and 9
-        specifying the level of compression: 1 produces the least
+        If mode is 'w' or 'a', compresslevel can be a number between 1
+        and 9 specifying the level of compression: 1 produces the least
         compression, and 9 (default) produces the most compression.
+
+        If mode is 'r', the input file may be the concatenation of
+        multiple compressed streams.
         """
         # This lock must be recursive, so that BufferedIOBase's
         # readline(), readlines() and writelines() don't deadlock.