classification
Title: Link directly to set and frozenset in built-in function docs
Type: enhancement Stage: resolved
Components: Documentation Versions: Python 3.2, Python 3.3, Python 3.4, Python 2.7
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: docs@python Nosy List: asvetlov, chris.jerdonek, docs@python, ezio.melotti, fossilet, jcea, python-dev
Priority: normal Keywords:

Created on 2012-11-08 13:59 by fossilet, last changed 2012-11-10 03:14 by chris.jerdonek. This issue is now closed.

Messages (7)
msg175157 - (view) Author: Yongzhi Pan (fossilet) * Date: 2012-11-08 13:59
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.
msg175159 - (view) Author: Andrew Svetlov (asvetlov) * (Python committer) Date: 2012-11-08 14:07
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.
msg175189 - (view) Author: Chris Jerdonek (chris.jerdonek) * (Python committer) Date: 2012-11-08 21:02
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).
msg175191 - (view) Author: Chris Jerdonek (chris.jerdonek) * (Python committer) Date: 2012-11-08 21:39
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
msg175259 - (view) Author: Roundup Robot (python-dev) (Python triager) Date: 2012-11-10 03:02
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
msg175260 - (view) Author: Roundup Robot (python-dev) (Python triager) Date: 2012-11-10 03:13
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
msg175261 - (view) Author: Chris Jerdonek (chris.jerdonek) * (Python committer) Date: 2012-11-10 03:14
Fixed.  Thanks a lot for the report, Yongzhi.
History
Date User Action Args
2012-11-10 03:14:35chris.jerdoneksetstatus: open -> closed
resolution: fixed
messages: + msg175261

stage: resolved
2012-11-10 03:13:20python-devsetmessages: + msg175260
2012-11-10 03:02:35python-devsetnosy: + python-dev
messages: + msg175259
2012-11-08 21:39:25chris.jerdoneksetmessages: + msg175191
2012-11-08 21:31:11chris.jerdoneksettitle: Missing anchor in doc -> Link directly to set and frozenset in built-in function docs
type: enhancement
versions: + Python 2.7, Python 3.2
2012-11-08 21:03:53chris.jerdoneksetnosy: + ezio.melotti
2012-11-08 21:02:35chris.jerdoneksetnosy: + chris.jerdonek
messages: + msg175189
2012-11-08 14:20:27jceasetnosy: + jcea
2012-11-08 14:07:06asvetlovsetnosy: + asvetlov
messages: + msg175159
2012-11-08 13:59:17fossiletcreate