update :class:str references to link to the str type section

[cjerdonek]

BPO	16205
Nosy	@ncoghlan, @ezio-melotti, @cjerdonek
Dependencies	bpo-16209: add a "class str" entry to the docs
Superseder	bpo-16209: add a "class str" entry to the docs

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = None
closed_at = <Date 2012-11-28.10:03:18.409>
created_at = <Date 2012-10-12.02:15:25.997>
labels = ['type-feature', 'docs']
title = 'update :class:`str` references to link to the str type section'
updated_at = <Date 2012-11-28.10:03:18.408>
user = 'https://github.com/cjerdonek'

bugs.python.org fields:

activity = <Date 2012-11-28.10:03:18.408>
actor = 'chris.jerdonek'
assignee = 'docs@python'
closed = True
closed_date = <Date 2012-11-28.10:03:18.409>
closer = 'chris.jerdonek'
components = ['Documentation']
creation = <Date 2012-10-12.02:15:25.997>
creator = 'chris.jerdonek'
dependencies = ['16209']
files = []
hgrepos = []
issue_num = 16205
keywords = []
message_count = 7.0
messages = ['172713', '172714', '172717', '172739', '172740', '172741', '176528']
nosy_count = 4.0
nosy_names = ['ncoghlan', 'ezio.melotti', 'chris.jerdonek', 'docs@python']
pr_nums = []
priority = 'normal'
resolution = 'duplicate'
stage = None
status = 'closed'
superseder = '16209'
type = 'enhancement'
url = 'https://bugs.python.org/issue16205'
versions = ['Python 3.3', 'Python 3.4']

[cjerdonek]

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 <textseq>`, but it would be nice to have a solution that makes "str" have the code-style font instead of italics.

[cjerdonek]

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.

[cjerdonek]

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

[ezio-melotti]

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.

[ezio-melotti]

Adding a class directive for str is tracked in bpo-16209.

[cjerdonek]

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.

[cjerdonek]

This was addressed by issue bpo-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 bpo-16568.