This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

Title: documentation of bz2 module mildly erroneous
Type: behavior Stage:
Components: Documentation Versions: Python 2.6
Status: closed Resolution: out of date
Dependencies: Superseder:
Assigned To: docs@python Nosy List: Matt.Wartell, docs@python, eric.araujo, georg.brandl
Priority: normal Keywords: patch

Created on 2010-05-03 07:03 by Matt.Wartell, last changed 2022-04-11 14:57 by admin. This issue is now closed.

File name Uploaded Description Edit
issue-8602.diff Matt.Wartell, 2010-05-08 01:11 context diff for 2.6.5 documentation tree
Messages (6)
msg104818 - (view) Author: Matt Wartell (Matt.Wartell) Date: 2010-05-03 07:03
This is related to "bz2.BZ2File should support "with" protocol per PEP 343"

The documentation at states:

   "This module provides a comprehensive interface for the bz2 compression library. It implements a complete file interface,..." 

although bz2.BZ2File does not support the __enter__ and __exit__ methods so arguably doesn't implement the "complete file interface". If issue8601 is declined then the documentation should probably note this exception.
msg105237 - (view) Author: Éric Araujo (eric.araujo) * (Python committer) Date: 2010-05-07 21:52
Now that #8601 is closed, would you mind providing a doc patch explaining the lack of context manager protocol support and its reason?
msg105248 - (view) Author: Matt Wartell (Matt.Wartell) Date: 2010-05-08 01:11
Per request, I have attached a context diff for both bz2.txt and 3.0.txt suitable for and respectively. 

The modification in bz2.txt may border on redundant and overly verbose and should be reviewed for style consistency.

I have sanity-checked the modified files with sphinx-build html which generates clean, consistent markup.
msg107756 - (view) Author: Éric Araujo (eric.araujo) * (Python committer) Date: 2010-06-13 21:59
I’d remove the lines “Specifically it does not define the :meth:`__enter__` and :meth:`__exit__` methods required by the :keyword:`with` statement”, since they add unnecessary length to a simple note.

Please provide one patch per branch, and diff from the top level of the checkout (see Thanks!
msg107757 - (view) Author: Éric Araujo (eric.araujo) * (Python committer) Date: 2010-06-13 22:01
Also, don’t bother with 3.0: It is not supported by python-dev anymore. Make documentation patches for py3k and trunk, and they’ll be backported to the stable branches 3.1 and 2.6.
msg112337 - (view) Author: Georg Brandl (georg.brandl) * (Python committer) Date: 2010-08-01 14:52
Now present in all maintained branches.
Date User Action Args
2022-04-11 14:57:00adminsetgithub: 52848
2010-08-01 14:52:11georg.brandlsetstatus: open -> closed

nosy: + georg.brandl
messages: + msg112337

resolution: out of date
2010-06-13 22:01:16eric.araujosetmessages: + msg107757
2010-06-13 21:59:59eric.araujosetstatus: pending -> open

messages: + msg107756
2010-05-08 01:11:43Matt.Wartellsetstatus: open -> pending
files: + issue-8602.diff
messages: + msg105248

keywords: + patch
2010-05-07 21:52:25eric.araujosetnosy: + eric.araujo
messages: + msg105237
2010-05-03 07:03:52Matt.Wartellcreate