Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[doc] incorrect sphinx object names #91035

Closed
not-my-profile mannequin opened this issue Feb 28, 2022 · 2 comments
Closed

[doc] incorrect sphinx object names #91035

not-my-profile mannequin opened this issue Feb 28, 2022 · 2 comments
Labels
3.7 (EOL) end of life 3.8 only security fixes 3.9 only security fixes 3.10 only security fixes 3.11 only security fixes docs Documentation in the Doc dir

Comments

@not-my-profile
Copy link
Mannequin

not-my-profile mannequin commented Feb 28, 2022

BPO 46879
Nosy @not-my-profile
PRs
  • bpo-46879: Fix incorrect sphinx object names in doc #31615
    		•

    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 = None
created_at = <Date 2022-02-28.12:47:50.085>
labels = ['3.8', '3.9', '3.10', '3.11', '3.7', 'docs']
title = '[doc] incorrect sphinx object names'
updated_at = <Date 2022-02-28.12:48:48.583>
user = 'https://github.com/not-my-profile'

    bugs.python.org fields:

    activity = <Date 2022-02-28.12:48:48.583>
actor = 'push-f'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2022-02-28.12:47:50.085>
creator = 'push-f'
dependencies = []
files = []
hgrepos = []
issue_num = 46879
keywords = ['patch']
message_count = 1.0
messages = ['414192']
nosy_count = 2.0
nosy_names = ['docs@python', 'push-f']
pr_nums = ['31615']
priority = 'normal'
resolution = None
stage = 'patch review'
status = 'open'
superseder = None
type = None
url = 'https://bugs.python.org/issue46879'
versions = ['Python 3.7', 'Python 3.8', 'Python 3.9', 'Python 3.10', 'Python 3.11']
    @not-my-profile
    Copy link
    Mannequin Author

    not-my-profile mannequin commented Feb 28, 2022

    API members documented in sphinx have an object name, which allow the
    documentation to be linked from other projects. Sphinx calculates the
    object name by prefixing the current module name to the directive
    argument, e.g:

    .. module:: foo
    .. function:: bar.baz

    becomes foo.bar.baz. Since these anchors aren't displayed in the
    documentation, some mistakes have crept in, namely the Python stdlib
    documentation currently contains the objects:

    • asyncio.asyncio.subprocess.DEVNULL
    • asyncio.asyncio.subprocess.PIPE
    • asyncio.asyncio.subprocess.STDOUT
    • asyncio.asyncio.subprocess.Process
    • multiprocessing.sharedctypes.multiprocessing.Manager
    • xml.etree.ElementTree.xml.etree.ElementInclude

    As can be observed in the URL fragments:
    https://docs.python.org/3/library/asyncio-subprocess.html#asyncio.asyncio.subprocess.Process
    https://docs.python.org/3/library/multiprocessing.html#multiprocessing.sharedctypes.multiprocessing.Manager
    https://docs.python.org/3/library/xml.etree.elementtree.html#xml.etree.ElementTree.xml.etree.ElementInclude.default_loader

    I have a patch, prepared, I'll send a PR straight away.

    @not-my-profile not-my-profile mannequin added 3.7 (EOL) end of life 3.8 only security fixes 3.9 only security fixes 3.10 only security fixes 3.11 only security fixes labels Feb 28, 2022
    @not-my-profile not-my-profile mannequin added docs Documentation in the Doc dir 3.7 (EOL) end of life 3.8 only security fixes 3.9 only security fixes 3.10 only security fixes 3.11 only security fixes labels Feb 28, 2022
    @not-my-profile not-my-profile mannequin added the docs Documentation in the Doc dir label Feb 28, 2022
    @ezio-melotti ezio-melotti transferred this issue from another repository Apr 10, 2022
    @ambv
    Copy link
    Contributor

    ambv commented May 19, 2022

    This is now fixed, thanks Martin!

    @ambv ambv closed this as completed May 19, 2022
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Assignees
    No one assigned
    Labels
    3.7 (EOL) end of life 3.8 only security fixes 3.9 only security fixes 3.10 only security fixes 3.11 only security fixes docs Documentation in the Doc dir
    Projects
    None yet
    Milestone
    No milestone
    Development

    No branches or pull requests
    1 participant
    @ambv