classification
Title: Non-idiomatic examples in gzip docs
Type: enhancement Stage: resolved
Components: Documentation Versions: Python 2.7
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: docs@python Nosy List: FrostyX, berker.peksag, docs@python, martin.panter, python-dev
Priority: normal Keywords: patch

Created on 2015-06-24 10:17 by FrostyX, last changed 2015-06-25 20:59 by berker.peksag. This issue is now closed.

Files
File name Uploaded Description Edit
idiomatic-gzip.diff FrostyX, 2015-06-24 10:17
Messages (4)
msg245729 - (view) Author: Jakub Kadlčík (FrostyX) * Date: 2015-06-24 10:17
Hello, I think there are awesome example code snippets in gzip documentation. No doubt, they helped me a lot.

The only problem is that they are not idiomatic. They look like C more than Python.

I suggest following patch
msg245730 - (view) Author: Martin Panter (martin.panter) * (Python committer) Date: 2015-06-24 11:04
It looks like this is for Python 2. I agree with the change, but I suggest back-porting revisions 35c53e7e2280, a01992e219c0 and ae1528beae67 (Issue 21146) instead, to match the Python 3 documentation.
msg245831 - (view) Author: Roundup Robot (python-dev) (Python triager) Date: 2015-06-25 20:56
New changeset 10eea15880db by Berker Peksag in branch '2.7':
Issue #24496: Backport gzip examples to Python 2.
https://hg.python.org/cpython/rev/10eea15880db
msg245832 - (view) Author: Berker Peksag (berker.peksag) * (Python committer) Date: 2015-06-25 20:59
Thanks for the patch, Jakub. I've updated the patch to match ae1528beae67 (thanks Martin) and commit it.
History
Date User Action Args
2015-06-25 20:59:41berker.peksagsetstatus: open -> closed

nosy: + berker.peksag
messages: + msg245832

resolution: fixed
stage: resolved
2015-06-25 20:56:50python-devsetnosy: + python-dev
messages: + msg245831
2015-06-24 11:04:22martin.pantersetnosy: + martin.panter

messages: + msg245730
versions: + Python 2.7
2015-06-24 10:17:12FrostyXcreate