[New-bugs-announce] [issue11203] gzip doc is behind

K Richard Pixley report at bugs.python.org
Sat Feb 12 20:40:32 CET 2011

New submission from K Richard Pixley <rich at noir.com>:

The documentation for gzip should include the "close" method.

It's use in the 2.7 documentation implies it's existence but it should also be stated explicitly that it exists.

In the 3.x documentation, the use of "close" not in the examples since the examples use context manager.  For 3.x documentation there should be both an explicit mention of the "close" method as well as an explicit mention that GzipFile supports the context manager protocol.

Yes, the use of the context manager in the examples implies that this is true but documentation on other modules states so explicitly so this module should too.

assignee: docs at python
components: Documentation
messages: 128460
nosy: docs at python, teamnoir
priority: normal
severity: normal
status: open
title: gzip doc is behind
type: feature request
versions: Python 2.7, Python 3.3

Python tracker <report at bugs.python.org>

More information about the New-bugs-announce mailing list