[issue16436] Missing anchor in doc

New submission from Yongzhi Pan: http://docs.python.org/3/library/functions.html#func-frozenset http://docs.python.org/3/library/functions.html#func-set frozenset and set function have no links to their definitions. Also the anchor name is prefixed with func, which is different to other builtin functions. ---------- assignee: docs@python components: Documentation messages: 175157 nosy: docs@python, fossilet priority: normal severity: normal status: open title: Missing anchor in doc versions: Python 3.3, Python 3.4 _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue16436> _______________________________________

Andrew Svetlov added the comment: I guess the reason is that names are classes, not functions. See http://docs.python.org/3/library/functions.html#func-dict also for example. ---------- nosy: +asvetlov _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue16436> _______________________________________

Changes by Jesús Cea Avión <jcea@jcea.es>: ---------- nosy: +jcea _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue16436> _______________________________________

Chris Jerdonek added the comment: Currently, the built-in types are not treated consistently as to whether their constructors are documented in the "Built-in Functions" or "Built-in Types" page. There are some open issues related to this topic (see, for example, issue 16209). For the purposes of this issue though, yes, I agree that the abbreviated built-in function versions of the documentation for set and frozenset should contain direct links to the more complete constructor documentation in the "Built-in Types" page (as is already done for dict, for example, as Andrew pointed out). ---------- nosy: +chris.jerdonek _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue16436> _______________________________________

Changes by Chris Jerdonek <chris.jerdonek@gmail.com>: ---------- nosy: +ezio.melotti _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue16436> _______________________________________

Changes by Chris Jerdonek <chris.jerdonek@gmail.com>: ---------- title: Missing anchor in doc -> Link directly to set and frozenset in built-in function docs type: -> enhancement versions: +Python 2.7, Python 3.2 _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue16436> _______________________________________

Chris Jerdonek added the comment: I recommend copying for set and frozenset the documentation pattern for dict (and in particular by stating explicitly in its own sentence that the object is a class): http://docs.python.org/3/library/functions.html#func-dict ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue16436> _______________________________________

Roundup Robot added the comment: New changeset 16fa6462dfe1 by Chris Jerdonek in branch '3.2': Link set and frozenset function docs to their class definitions (issue #16436). http://hg.python.org/cpython/rev/16fa6462dfe1 New changeset d534da27ca8b by Chris Jerdonek in branch '3.3': Merge from 3.2: adjust set and frozenset function docs (issue #16436). http://hg.python.org/cpython/rev/d534da27ca8b New changeset 1fde0d70f2b8 by Chris Jerdonek in branch 'default': Merge from 3.3: adjust set and frozenset function docs (issue #16436). http://hg.python.org/cpython/rev/1fde0d70f2b8 ---------- nosy: +python-dev _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue16436> _______________________________________

Roundup Robot added the comment: New changeset 24db5292c2c9 by Chris Jerdonek in branch '2.7': Backport from 3.2: adjust set and frozenset function docs (issue #16436). http://hg.python.org/cpython/rev/24db5292c2c9 ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue16436> _______________________________________

Chris Jerdonek added the comment: Fixed. Thanks a lot for the report, Yongzhi. ---------- resolution: -> fixed stage: -> committed/rejected status: open -> closed _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue16436> _______________________________________
participants (5)
-
Andrew Svetlov
-
Chris Jerdonek
-
Jesús Cea Avión
-
Roundup Robot
-
Yongzhi Pan