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

Broken references in dataclasses docs #103810

Closed
olgarithms opened this issue Apr 24, 2023 · 3 comments
Closed

Broken references in dataclasses docs #103810

olgarithms opened this issue Apr 24, 2023 · 3 comments
Labels
docs Documentation in the Doc dir

Comments

@olgarithms
Copy link
Contributor

olgarithms commented Apr 24, 2023 •
edited by bedevere-bot
Loading

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
@olgarithms olgarithms added the docs Documentation in the Doc dir label Apr 24, 2023
olgarithms added a commit to olgarithms/cpython that referenced this issue Apr 24, 2023
@olgarithms
pythongh-103810: Fix broken references in dataclasses
a9a8129
@bedevere-bot bedevere-bot mentioned this issue Apr 24, 2023
Merged
@olgarithms
Copy link
Contributor Author

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

@hugovk
Copy link
Member

hugovk commented Apr 24, 2023

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

ambv pushed a commit that referenced this issue Apr 24, 2023
@olgarithms @hugovk
gh-103810: Fix broken references in dataclasses (#103811)
0f23eda 
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
ambv pushed a commit to ambv/cpython that referenced this issue Apr 24, 2023
@olgarithms @ambv
[3.11] pythongh-103810: Fix broken references in dataclasses (pythonG…
319ab15 
…H-103811)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
(cherry picked from commit 0f23eda)

Co-authored-by: Olga Matoula <olgamatoula@gmail.com>
@bedevere-bot bedevere-bot mentioned this issue Apr 24, 2023
Merged
ambv added a commit that referenced this issue Apr 24, 2023
@ambv @olgarithms
[3.11] gh-103810: Fix broken references in dataclasses (GH-103811) (#…
56d50dd 
…103813)

(cherry picked from commit 0f23eda)

Co-authored-by: Olga Matoula <olgamatoula@gmail.com>
@olgarithms
Copy link
Contributor Author

Fixed in #103811

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs Documentation in the Doc dir
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@hugovk @olgarithms