[issue16206] dict() docs should display multiple signatures
New submission from Chris Jerdonek: The documentation for dict() (for both the built-in function and the class constructor) should display multiple signatures as do dict.__doc__ and the documentation for, say, str(). Currently, the dict() documentation just has one signature: dict([arg]) Something more in line with the docstring would be better, for example: dict(mapping={}) dict(iterable) dict(**kwargs) ---------- assignee: docs@python components: Documentation keywords: easy messages: 172718 nosy: chris.jerdonek, docs@python, ezio.melotti priority: normal severity: normal status: open title: dict() docs should display multiple signatures versions: Python 2.7, Python 3.2, Python 3.3, Python 3.4 _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue16206> _______________________________________
Chris Jerdonek added the comment: Attaching proposed patch. ---------- keywords: +patch Added file: http://bugs.python.org/file27546/issue-16206-1-default.patch _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue16206> _______________________________________
Roundup Robot added the comment: New changeset ed6da2a8361c by Chris Jerdonek in branch '3.2': Issue #16206: Improve the documentation of the dict constructor. http://hg.python.org/cpython/rev/ed6da2a8361c New changeset 02de13d69149 by Chris Jerdonek in branch '3.3': Issue #16206: Merge dict documentation improvements from 3.2. http://hg.python.org/cpython/rev/02de13d69149 New changeset 392e09ba9feb by Chris Jerdonek in branch 'default': Issue #16206: Merge dict documentation improvements from 3.3. http://hg.python.org/cpython/rev/392e09ba9feb ---------- nosy: +python-dev _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue16206> _______________________________________
Roundup Robot added the comment: New changeset 5fc6f47974db by Chris Jerdonek in branch '2.7': Issue #16206: Backport dict documentation improvements from 3.2. http://hg.python.org/cpython/rev/5fc6f47974db ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue16206> _______________________________________
Changes by Chris Jerdonek <chris.jerdonek@gmail.com>: ---------- resolution: -> fixed stage: -> committed/rejected status: open -> closed _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue16206> _______________________________________
Roundup Robot added the comment: New changeset 361beec678e1 by Ezio Melotti in branch '2.7': #16206: Improve examples about dict construction. http://hg.python.org/cpython/rev/361beec678e1 New changeset eb999002916c by Ezio Melotti in branch '3.2': #16206: Improve examples about dict construction. http://hg.python.org/cpython/rev/eb999002916c New changeset 2c1fff6f8956 by Ezio Melotti in branch '3.3': #16206: merge with 3.2. http://hg.python.org/cpython/rev/2c1fff6f8956 New changeset 46ce82b4c1fa by Ezio Melotti in branch 'default': #16206: merge with 3.3. http://hg.python.org/cpython/rev/46ce82b4c1fa ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue16206> _______________________________________
participants (2)
-
Chris Jerdonek -
Roundup Robot