[issue19067] Built-in range docstrings are not PEP-8 compatible
Roundup Robot added the comment: New changeset 5135a431f7b3 by Ezio Melotti in branch '3.3': #19067: use imperative mood in range object docstrings. Patch by Marco Buttu. http://hg.python.org/cpython/rev/5135a431f7b3 New changeset b2c752eff474 by Ezio Melotti in branch 'default': #19067: merge with 3.3. http://hg.python.org/cpython/rev/b2c752eff474 -- nosy: +python-dev ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue19067 ___ ___ Python-bugs-list mailing list Unsubscribe: https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue19067] Built-in range docstrings are not PEP-8 compatible
Ezio Melotti added the comment: Fixed, thanks for the patch! -- assignee: docs@python - ezio.melotti nosy: +ezio.melotti resolution: - fixed stage: patch review - committed/rejected status: open - closed ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue19067 ___ ___ Python-bugs-list mailing list Unsubscribe: https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue19067] Built-in range docstrings are not PEP-8 compatible
Terry J. Reedy added the comment: PEP8 just says PEP 257 describes good docstring conventions. PEP 257 is what says '''It [the one line docstring] prescribes the function or method's effect as a command (Do this, Return that), not as a description; e.g. don't write Returns the pathname ''' I strongly prefer the rule, but we do not usually patch purely for PEP8 compliance. However, a docstring patch is safer than a code patch. -- nosy: +terry.reedy stage: - patch review versions: -Python 3.1 ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue19067 ___ ___ Python-bugs-list mailing list Unsubscribe: https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue19067] Built-in range docstrings are not PEP-8 compatible
Terry J. Reedy added the comment: I asked on py-dev whether to do this. #19068 and #19069 are similar issues for complex and float docstrings. -- ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue19067 ___ ___ Python-bugs-list mailing list Unsubscribe: https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue19067] Built-in range docstrings are not PEP-8 compatible
Changes by Tshepang Lekhonkhobe tshep...@gmail.com: -- nosy: +tshepang ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue19067 ___ ___ Python-bugs-list mailing list Unsubscribe: https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue19067] Built-in range docstrings are not PEP-8 compatible
Changes by Raymond Hettinger raymond.hettin...@gmail.com: -- priority: normal - low ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue19067 ___ ___ Python-bugs-list mailing list Unsubscribe: https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue19067] Built-in range docstrings are not PEP-8 compatible
New submission from Marco Buttu: The range documentation is not PEP-8 compatible: range.__doc__.splitlines()[-1] 'Returns a virtual sequence of numbers from start to stop by step.' range.__reversed__.__doc__ 'Returns a reverse iterator.' range.index.__doc__.splitlines()[-1] 'Raises ValueError if the value is not present.' They should have been 'Return...' and 'Raise...'. Patch is attached -- assignee: docs@python components: Documentation files: rangeobject.patch keywords: patch messages: 198244 nosy: docs@python, marco.buttu priority: normal severity: normal status: open title: Built-in range docstrings are not PEP-8 compatible type: enhancement versions: Python 3.1, Python 3.2, Python 3.3 Added file: http://bugs.python.org/file31838/rangeobject.patch ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue19067 ___ ___ Python-bugs-list mailing list Unsubscribe: https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
