[issue18912] Intendation issue in example code in itertools.count documentation
New submission from Jeroen Van Goey: The sample code in the itertools.count documentation should be indented by 4 spaces. For 2.7.4: lines 3429 till 3432 in http://hg.python.org/releasing/2.7.4/file/026ee0057e2d/Modules/itertoolsmodu... For 3.4.0a1: lines 3981 till 3984 in http://hg.python.org/releasing/py3.4.0a1/file/edc668a667ad/Modules/itertools... Also, the example code uses the arguments 'firstval' and 'step' whereas the documentation of the function itself uses the arguments 'start' and 'step'. Maybe better be consistent and use as first argument 'start' in both cases? ---------- assignee: docs@python components: Documentation hgrepos: 207 messages: 196826 nosy: docs@python, jeroen-vangoey priority: normal severity: normal status: open title: Intendation issue in example code in itertools.count documentation type: enhancement versions: Python 2.7, Python 3.4 _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue18912> _______________________________________
Changes by Jeroen Van Goey <jeroen.vangoey@gmail.com>: ---------- hgrepos: -207 _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue18912> _______________________________________
Jeroen Van Goey added the comment: Patch for Python 2.7.4 attached ---------- keywords: +patch Added file: http://bugs.python.org/file31571/2.7itertoolsmodule.c.patch _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue18912> _______________________________________
Jeroen Van Goey added the comment: Patch for Python 3.4.0a1 attached ---------- Added file: http://bugs.python.org/file31572/3.4itertoolsmodule.c.patch _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue18912> _______________________________________
Changes by Andrew Svetlov <andrew.svetlov@gmail.com>: ---------- stage: -> patch review _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue18912> _______________________________________
Eli Bendersky added the comment: LGTM, thanks ---------- nosy: +eli.bendersky _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue18912> _______________________________________
Roundup Robot added the comment: New changeset 8e174ee0575a by Eli Bendersky in branch '3.3': Issue #18912: Fix indentation in docstring http://hg.python.org/cpython/rev/8e174ee0575a New changeset 31ef590a0d2f by Eli Bendersky in branch 'default': Issue #18912: Fix indentation in docstring http://hg.python.org/cpython/rev/31ef590a0d2f ---------- nosy: +python-dev _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue18912> _______________________________________
Roundup Robot added the comment: New changeset a559cda6a498 by Eli Bendersky in branch '2.7': Close #18912: Fix indentation in docstring http://hg.python.org/cpython/rev/a559cda6a498 ---------- resolution: -> fixed stage: patch review -> committed/rejected status: open -> closed _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue18912> _______________________________________
Raymond Hettinger added the comment: Please assign itertools doc changes to me in the future. ---------- nosy: +rhettinger _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue18912> _______________________________________
participants (5)
-
Andrew Svetlov -
Eli Bendersky
-
Jeroen Van Goey
-
Raymond Hettinger
-
Roundup Robot