summaryrefslogtreecommitdiffstats
path: root/Doc/library/bz2.rst
diff options
context:
space:
mode:
authorMatthias Bussonnier <bussonniermatthias@gmail.com>2018-09-11 01:15:56 (GMT)
committerGregory P. Smith <greg@krypto.org>2018-09-11 01:15:56 (GMT)
commitffa198c642f9c67b84ef192bf0f7016c4249e570 (patch)
tree724261c145d917546a9b88883e4888bf825a11d0 /Doc/library/bz2.rst
parentf019579828ed62653e2d41c95278308fa076ccaf (diff)
downloadcpython-ffa198c642f9c67b84ef192bf0f7016c4249e570.zip
cpython-ffa198c642f9c67b84ef192bf0f7016c4249e570.tar.gz
cpython-ffa198c642f9c67b84ef192bf0f7016c4249e570.tar.bz2
bpo-33487: improve BZ2File Deprecation and documentation. (GH-6785)
Emit warning when None passed explicitly, list Python version since deprecation in warning message and docs.
Diffstat (limited to 'Doc/library/bz2.rst')
-rw-r--r--Doc/library/bz2.rst6
1 files changed, 5 insertions, 1 deletions
diff --git a/Doc/library/bz2.rst b/Doc/library/bz2.rst
index d5f6225..946cc67 100644
--- a/Doc/library/bz2.rst
+++ b/Doc/library/bz2.rst
@@ -81,7 +81,7 @@ All of the classes in this module may safely be accessed from multiple threads.
If *filename* is a file object (rather than an actual file name), a mode of
``'w'`` does not truncate the file, and is instead equivalent to ``'a'``.
- The *buffering* argument is ignored. Its use is deprecated.
+ The *buffering* argument is ignored. Its use is deprecated since Python 3.0.
If *mode* is ``'w'`` or ``'a'``, *compresslevel* can be a number between
``1`` and ``9`` specifying the level of compression: ``1`` produces the
@@ -109,6 +109,10 @@ All of the classes in this module may safely be accessed from multiple threads.
.. versionadded:: 3.3
+
+ .. deprecated:: 3.0
+ The keyword argument *buffering* was deprecated and is now ignored.
+
.. versionchanged:: 3.1
Support for the :keyword:`with` statement was added.