Skip to content

Broken references in dataclasses docs #103810

Description

@olgarithms

When building the dataclasses docs in nitpicky mode , there are some warnings for broken references. Confirmed that the links in the live docs are also broken.

make SPHINXOPTS="-n --keep-going" html

/Users/omatoula/Documents/projects/cpython/Doc/library/dataclasses.rst:14: WARNING: py:meth reference target not found: __init__                       
/Users/omatoula/Documents/projects/cpython/Doc/library/dataclasses.rst:14: WARNING: py:meth reference target not found: __repr__
/Users/omatoula/Documents/projects/cpython/Doc/library/dataclasses.rst:34: WARNING: py:meth reference target not found: __init__
/Users/omatoula/Documents/projects/cpython/Doc/library/dataclasses.rst:89: WARNING: py:meth reference target not found: __init__
/Users/omatoula/Documents/projects/cpython/Doc/library/dataclasses.rst:92: WARNING: py:meth reference target not found: __init__
/Users/omatoula/Documents/projects/cpython/Doc/library/dataclasses.rst:95: WARNING: py:meth reference target not found: __repr__
/Users/omatoula/Documents/projects/cpython/Doc/library/dataclasses.rst:102: WARNING: py:meth reference target not found: __repr__
/Users/omatoula/Documents/projects/cpython/Doc/library/dataclasses.rst:105: WARNING: py:meth reference target not found: __eq__
/Users/omatoula/Documents/projects/cpython/Doc/library/dataclasses.rst:110: WARNING: py:meth reference target not found: __eq__
/Users/omatoula/Documents/projects/cpython/Doc/library/dataclasses.rst:113: WARNING: py:meth reference target not found: __lt__
/Users/omatoula/Documents/projects/cpython/Doc/library/dataclasses.rst:113: WARNING: py:meth reference target not found: __le__
/Users/omatoula/Documents/projects/cpython/Doc/library/dataclasses.rst:113: WARNING: py:meth reference target not found: __gt__
/Users/omatoula/Documents/projects/cpython/Doc/library/dataclasses.rst:113: WARNING: py:meth reference target not found: __ge__
/Users/omatoula/Documents/projects/cpython/Doc/library/dataclasses.rst:120: WARNING: py:meth reference target not found: __lt__
/Users/omatoula/Documents/projects/cpython/Doc/library/dataclasses.rst:120: WARNING: py:meth reference target not found: __le__
/Users/omatoula/Documents/projects/cpython/Doc/library/dataclasses.rst:120: WARNING: py:meth reference target not found: __gt__
/Users/omatoula/Documents/projects/cpython/Doc/library/dataclasses.rst:120: WARNING: py:meth reference target not found: __ge__
/Users/omatoula/Documents/projects/cpython/Doc/library/dataclasses.rst:124: WARNING: py:meth reference target not found: __hash__
/Users/omatoula/Documents/projects/cpython/Doc/library/dataclasses.rst:127: WARNING: py:meth reference target not found: __hash__
/Users/omatoula/Documents/projects/cpython/Doc/library/dataclasses.rst:127: WARNING: py:meth reference target not found: __hash__
/Users/omatoula/Documents/projects/cpython/Doc/library/dataclasses.rst:127: WARNING: py:meth reference target not found: __eq__
/Users/omatoula/Documents/projects/cpython/Doc/library/dataclasses.rst:134: WARNING: py:meth reference target not found: __hash__
/Users/omatoula/Documents/projects/cpython/Doc/library/dataclasses.rst:134: WARNING: py:meth reference target not found: __hash__
/Users/omatoula/Documents/projects/cpython/Doc/library/dataclasses.rst:134: WARNING: py:meth reference target not found: __hash__
/Users/omatoula/Documents/projects/cpython/Doc/library/dataclasses.rst:140: WARNING: py:meth reference target not found: __hash__
/Users/omatoula/Documents/projects/cpython/Doc/library/dataclasses.rst:140: WARNING: py:meth reference target not found: __hash__
/Users/omatoula/Documents/projects/cpython/Doc/library/dataclasses.rst:140: WARNING: py:meth reference target not found: __hash__
/Users/omatoula/Documents/projects/cpython/Doc/library/dataclasses.rst:147: WARNING: py:meth reference target not found: __hash__
/Users/omatoula/Documents/projects/cpython/Doc/library/dataclasses.rst:147: WARNING: py:meth reference target not found: __hash__
/Users/omatoula/Documents/projects/cpython/Doc/library/dataclasses.rst:152: WARNING: py:meth reference target not found: __hash__
/Users/omatoula/Documents/projects/cpython/Doc/library/dataclasses.rst:152: WARNING: py:meth reference target not found: __hash__
/Users/omatoula/Documents/projects/cpython/Doc/library/dataclasses.rst:152: WARNING: py:meth reference target not found: __hash__
/Users/omatoula/Documents/projects/cpython/Doc/library/dataclasses.rst:152: WARNING: py:meth reference target not found: __hash__
/Users/omatoula/Documents/projects/cpython/Doc/library/dataclasses.rst:160: WARNING: py:meth reference target not found: __setattr__
/Users/omatoula/Documents/projects/cpython/Doc/library/dataclasses.rst:160: WARNING: py:meth reference target not found: __delattr__
/Users/omatoula/Documents/projects/cpython/Doc/library/dataclasses.rst:165: WARNING: py:meth reference target not found: __init__
/Users/omatoula/Documents/projects/cpython/Doc/library/dataclasses.rst:165: WARNING: py:meth reference target not found: __init__
/Users/omatoula/Documents/projects/cpython/Doc/library/dataclasses.rst:174: WARNING: py:meth reference target not found: __init__
/Users/omatoula/Documents/projects/cpython/Doc/library/dataclasses.rst:174: WARNING: py:meth reference target not found: __init__
/Users/omatoula/Documents/projects/cpython/Doc/library/dataclasses.rst:185: WARNING: py:attr reference target not found: __slots__
/Users/omatoula/Documents/projects/cpython/Doc/library/dataclasses.rst:185: WARNING: py:attr reference target not found: __slots__
/Users/omatoula/Documents/projects/cpython/Doc/library/dataclasses.rst:217: WARNING: py:meth reference target not found: __init__
/Users/omatoula/Documents/projects/cpython/Doc/library/dataclasses.rst:258: WARNING: py:meth reference target not found: __init__
/Users/omatoula/Documents/projects/cpython/Doc/library/dataclasses.rst:261: WARNING: py:meth reference target not found: __repr__
/Users/omatoula/Documents/projects/cpython/Doc/library/dataclasses.rst:264: WARNING: py:meth reference target not found: __hash__
/Users/omatoula/Documents/projects/cpython/Doc/library/dataclasses.rst:277: WARNING: py:meth reference target not found: __eq__
/Users/omatoula/Documents/projects/cpython/Doc/library/dataclasses.rst:277: WARNING: py:meth reference target not found: __gt__
/Users/omatoula/Documents/projects/cpython/Doc/library/dataclasses.rst:289: WARNING: py:meth reference target not found: __init__
/Users/omatoula/Documents/projects/cpython/Doc/library/dataclasses.rst:438: WARNING: py:meth reference target not found: __init__
/Users/omatoula/Documents/projects/cpython/Doc/library/dataclasses.rst:438: WARNING: py:meth reference target not found: __post_init__
/Users/omatoula/Documents/projects/cpython/Doc/library/dataclasses.rst:442: WARNING: py:meth reference target not found: __init__
/Users/omatoula/Documents/projects/cpython/Doc/library/dataclasses.rst:442: WARNING: py:meth reference target not found: __post_init__
/Users/omatoula/Documents/projects/cpython/Doc/library/dataclasses.rst:450: WARNING: py:meth reference target not found: __post_init__
/Users/omatoula/Documents/projects/cpython/Doc/library/dataclasses.rst:477: WARNING: py:meth reference target not found: __init__
/Users/omatoula/Documents/projects/cpython/Doc/library/dataclasses.rst:504: WARNING: py:meth reference target not found: __setattr__
/Users/omatoula/Documents/projects/cpython/Doc/library/dataclasses.rst:504: WARNING: py:meth reference target not found: __delattr__
/Users/omatoula/Documents/projects/cpython/Doc/library/dataclasses.rst:511: WARNING: py:meth reference target not found: __init__
/Users/omatoula/Documents/projects/cpython/Doc/library/dataclasses.rst:511: WARNING: py:meth reference target not found: __post_init__
/Users/omatoula/Documents/projects/cpython/Doc/library/dataclasses.rst:511: WARNING: py:meth reference target not found: __post_init__
/Users/omatoula/Documents/projects/cpython/Doc/library/dataclasses.rst:511: WARNING: py:meth reference target not found: __post_init__
/Users/omatoula/Documents/projects/cpython/Doc/library/dataclasses.rst:511: WARNING: py:meth reference target not found: __init__
/Users/omatoula/Documents/projects/cpython/Doc/library/dataclasses.rst:511: WARNING: py:meth reference target not found: __post_init__
/Users/omatoula/Documents/projects/cpython/Doc/library/dataclasses.rst:531: WARNING: py:meth reference target not found: __init__
/Users/omatoula/Documents/projects/cpython/Doc/library/dataclasses.rst:531: WARNING: py:meth reference target not found: __init__
/Users/omatoula/Documents/projects/cpython/Doc/library/dataclasses.rst:531: WARNING: py:meth reference target not found: __init__
/Users/omatoula/Documents/projects/cpython/Doc/library/dataclasses.rst:531: WARNING: py:meth reference target not found: __post_init__
/Users/omatoula/Documents/projects/cpython/Doc/library/dataclasses.rst:548: WARNING: py:meth reference target not found: __init__
/Users/omatoula/Documents/projects/cpython/Doc/library/dataclasses.rst:552: WARNING: py:meth reference target not found: __post_init__
/Users/omatoula/Documents/projects/cpython/Doc/library/dataclasses.rst:570: WARNING: py:meth reference target not found: __init__
/Users/omatoula/Documents/projects/cpython/Doc/library/dataclasses.rst:570: WARNING: py:meth reference target not found: __post_init__
/Users/omatoula/Documents/projects/cpython/Doc/library/dataclasses.rst:601: WARNING: py:meth reference target not found: __setattr__
/Users/omatoula/Documents/projects/cpython/Doc/library/dataclasses.rst:601: WARNING: py:meth reference target not found: __delattr__
/Users/omatoula/Documents/projects/cpython/Doc/library/dataclasses.rst:607: WARNING: py:meth reference target not found: __init__
/Users/omatoula/Documents/projects/cpython/Doc/library/dataclasses.rst:637: WARNING: py:meth reference target not found: __init__
/Users/omatoula/Documents/projects/cpython/Doc/library/dataclasses.rst:641: WARNING: py:meth reference target not found: __init__
/Users/omatoula/Documents/projects/cpython/Doc/library/dataclasses.rst:644: WARNING: py:meth reference target not found: __init__
/Users/omatoula/Documents/projects/cpython/Doc/library/dataclasses.rst:665: WARNING: py:meth reference target not found: __init__
/Users/omatoula/Documents/projects/cpython/Doc/library/dataclasses.rst:673: WARNING: py:meth reference target not found: __init__
/Users/omatoula/Documents/projects/cpython/Doc/library/dataclasses.rst:686: WARNING: py:meth reference target not found: __init__
/Users/omatoula/Documents/projects/cpython/Doc/library/dataclasses.rst:686: WARNING: py:meth reference target not found: __init__

Linked PRs

Activity

  1. olgarithms commented on Apr 24, 2023

    @olgarithms
    ContributorAuthor

    Hey @CAM-Gerlach, @hugovk, lmk if this looks good!

  2. hugovk commented on Apr 24, 2023

    @hugovk
    Member

    Thank you!

    By the way for future PRs: we usually don't need issues for docs PRs, and in the case of nit-picky fixes, we can use this big umbrella one: #101100

  3. added 3 commits that reference this issue on Apr 24, 2023
  4. olgarithms commented on Apr 24, 2023

    @olgarithms
    ContributorAuthor

    Fixed in #103811

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    docsDocumentation in the Doc dir

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions