]> granicus.if.org Git - python/commitdiff
Fix docs bz.open default mode (GH-15100)
authorRichard Sanger <rsangerarj@gmail.com>
Mon, 9 Sep 2019 15:49:47 +0000 (03:49 +1200)
committerT. Wouters <thomas@python.org>
Mon, 9 Sep 2019 15:49:47 +0000 (08:49 -0700)
bz2.open()'s default mode is rb, not r

Doc/library/bz2.rst

index 277de601cb7b6ff65b5a15b7443a94dbd064bd94..aa836af2b257fddb763d65487c5172ee520eb494 100644 (file)
@@ -31,7 +31,7 @@ All of the classes in this module may safely be accessed from multiple threads.
 (De)compression of files
 ------------------------
 
-.. function:: open(filename, mode='r', compresslevel=9, encoding=None, errors=None, newline=None)
+.. function:: open(filename, mode='rb', compresslevel=9, encoding=None, errors=None, newline=None)
 
    Open a bzip2-compressed file in binary or text mode, returning a :term:`file
    object`.