Issue 16205: update :class:str references to link to the str type section (original) (raw)

This issue has been migrated to GitHub: https://github.com/python/cpython/issues/60409

classification

process

Created on 2012-10-12 02:15 by chris.jerdonek, last changed 2022-04-11 14:57 by admin. This issue is now closed.

Messages (7)
msg172713 - (view)	Author: Chris Jerdonek (chris.jerdonek) *	Date: 2012-10-12 02:15
3.3 added a dedicated section to the docs for the str type. However, references to :class:`str` still link to the documentation of the built-in function str(). This issue is to update references to the str class to point to the new section on the str type. We could use :ref:`str `, but it would be nice to have a solution that makes "str" have the code-style font instead of italics.
msg172714 - (view)	Author: Chris Jerdonek (chris.jerdonek) *	Date: 2012-10-12 02:59
I'm not sure if Sphinx would allow it, but it would be nice if references to the function str() could link to the built-in function documentation, and references to the class str could link to the section on the str type.
msg172717 - (view)	Author: Chris Jerdonek (chris.jerdonek) *	Date: 2012-10-12 03:19
The documentation seems to take a similar approach with dict: http://docs.python.org/dev/library/stdtypes.html#dict http://docs.python.org/dev/library/functions.html#func-dict
msg172739 - (view)	Author: Ezio Melotti (ezio.melotti) *	Date: 2012-10-12 11:40
If :class:`str` and :func:`str` point respectively to stdtypes.rst and functions.rst once a class directive is added to stdtypes.rst, then we can do that. We might than need to update a few links to use :class: instead of :func:, and possibly use :ref:`textseq` where appropriate.
msg172740 - (view)	Author: Ezio Melotti (ezio.melotti) *	Date: 2012-10-12 11:44
Adding a class directive for str is tracked in #16209.
msg172741 - (view)	Author: Chris Jerdonek (chris.jerdonek) *	Date: 2012-10-12 11:46
> If :class:`str` and :func:`str` point respectively to stdtypes.rst and functions.rst once a class directive is added to stdtypes.rst, then we can do that. I agree. I would suggest starting small by adding a stub class entry above the string methods. The class constructor could link to the built-in function str() for its definition.
msg176528 - (view)	Author: Chris Jerdonek (chris.jerdonek) *	Date: 2012-11-28 10:03
This was addressed by issue #16209 since with that change :class:`str` and :func:`str` now both go to the new str class entry in the string type section. See also the new issue #16568.