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.

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

Improve cross-references in the data model documentation #89998

Closed
AlexWaygood opened this issue Nov 19, 2021 · 5 comments
Closed

Improve cross-references in the data model documentation #89998

AlexWaygood opened this issue Nov 19, 2021 · 5 comments
Labels
3.9 only security fixes 3.10 only security fixes 3.11 bug and security fixes docs Documentation in the Doc dir type-bug An unexpected behavior, bug, or error

Comments

@AlexWaygood
Copy link
Member

BPO 45840
Nosy @serhiy-storchaka, @AlexWaygood
PRs
  • bpo-45840: Improve cross-references in the data model documentation #29633
  • [3.10] bpo-45840: Improve cross-references in the data model documentation (GH-29633) #30077
  • [3.9] bpo-45840: Improve cross-references in the data model documentation (GH-29633) #30081
  • 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 2021-12-13.12:19:38.802>
    created_at = <Date 2021-11-19.02:01:26.925>
    labels = ['3.11', 'type-bug', '3.9', '3.10', 'docs']
    title = 'Improve cross-references in the data model documentation'
    updated_at = <Date 2021-12-13.13:05:16.076>
    user = 'https://github.com/AlexWaygood'

    bugs.python.org fields:

    activity = <Date 2021-12-13.13:05:16.076>
    actor = 'AlexWaygood'
    assignee = 'docs@python'
    closed = True
    closed_date = <Date 2021-12-13.12:19:38.802>
    closer = 'serhiy.storchaka'
    components = ['Documentation']
    creation = <Date 2021-11-19.02:01:26.925>
    creator = 'AlexWaygood'
    dependencies = []
    files = []
    hgrepos = []
    issue_num = 45840
    keywords = ['patch']
    message_count = 5.0
    messages = ['406569', '407741', '408429', '408448', '408450']
    nosy_count = 3.0
    nosy_names = ['docs@python', 'serhiy.storchaka', 'AlexWaygood']
    pr_nums = ['29633', '30077', '30081']
    priority = 'normal'
    resolution = 'fixed'
    stage = 'resolved'
    status = 'closed'
    superseder = None
    type = 'behavior'
    url = 'https://bugs.python.org/issue45840'
    versions = ['Python 3.9', 'Python 3.10', 'Python 3.11']

    @AlexWaygood
    Copy link
    Member Author

    The documentation for the data model has a lot of cross-references to other parts of the data model. However, often these cross-references do not have proper hyperlinks online, as :meth:`__iter__` is used (for example), instead of :meth:`~object.__iter__`. The documentation would be much more readable and navigable if this were fixed.

    @AlexWaygood AlexWaygood added 3.9 only security fixes 3.10 only security fixes 3.11 bug and security fixes labels Nov 19, 2021
    @AlexWaygood AlexWaygood added 3.11 bug and security fixes docs Documentation in the Doc dir labels Nov 19, 2021
    @AlexWaygood AlexWaygood added docs Documentation in the Doc dir type-bug An unexpected behavior, bug, or error labels Nov 19, 2021
    @serhiy-storchaka
    Copy link
    Member

    New changeset c0521fe by Alex Waygood in branch 'main':
    bpo-45840: Improve cross-references in the data model documentation (GH-29633)
    c0521fe

    @serhiy-storchaka
    Copy link
    Member

    New changeset 7da9025 by Alex Waygood in branch '3.10':
    bpo-45840: Improve cross-references in the data model documentation (GH-29633) (GH-30077)
    7da9025

    @serhiy-storchaka
    Copy link
    Member

    New changeset 2029c58 by Alex Waygood in branch '3.9':
    [3.9] bpo-45840: Improve cross-references in the data model documentation (GH-29633) (GH-30081)
    2029c58

    @AlexWaygood
    Copy link
    Member Author

    Thanks, Serhiy!

    @ezio-melotti ezio-melotti transferred this issue from another repository Apr 10, 2022
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    3.9 only security fixes 3.10 only security fixes 3.11 bug and security fixes docs Documentation in the Doc dir type-bug An unexpected behavior, bug, or error
    Projects
    None yet
    Development

    No branches or pull requests

    2 participants