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

gh-101100: Fix Sphinx warnings in whatsnew/3.2.rst #115580

Merged
merged 3 commits into from
Feb 17, 2024

Conversation

hugovk
Copy link
Member

@hugovk hugovk commented Feb 16, 2024

Fix 49 warnings:

Doc/whatsnew/3.2.rst:345: WARNING: py:class reference target not found: importlib.abc.PyLoader
Doc/whatsnew/3.2.rst:345: WARNING: py:class reference target not found: importlib.abc.PyPycLoader
Doc/whatsnew/3.2.rst:400: WARNING: py:func reference target not found: start_response
Doc/whatsnew/3.2.rst:418: WARNING: py:meth reference target not found: write
Doc/whatsnew/3.2.rst:418: WARNING: py:func reference target not found: start_response
Doc/whatsnew/3.2.rst:500: WARNING: py:meth reference target not found: __getattr__
Doc/whatsnew/3.2.rst:500: WARNING: py:meth reference target not found: __getattribute__
Doc/whatsnew/3.2.rst:621: WARNING: py:class reference target not found: collections.Sequence
Doc/whatsnew/3.2.rst:723: WARNING: py:mod reference target not found: xml.etree.cElementTree
Doc/whatsnew/3.2.rst:1010: WARNING: py:data reference target not found: time.accept2dyear
Doc/whatsnew/3.2.rst:1015: WARNING: py:data reference target not found: time.accept2dyear
Doc/whatsnew/3.2.rst:1034: WARNING: py:data reference target not found: time.accept2dyear
Doc/whatsnew/3.2.rst:1151: WARNING: py:meth reference target not found: __repr__
Doc/whatsnew/3.2.rst:1157: WARNING: py:meth reference target not found: __repr__
Doc/whatsnew/3.2.rst:1157: WARNING: py:meth reference target not found: __repr__
Doc/whatsnew/3.2.rst:1338: WARNING: py:attr reference target not found: Context.clamp
Doc/whatsnew/3.2.rst:1431: WARNING: py:class reference target not found: zipfile.ZipExtFile
Doc/whatsnew/3.2.rst:1599: WARNING: py:attr reference target not found: sqlite3.Connection.in_transit
Doc/whatsnew/3.2.rst:1646: WARNING: py:func reference target not found: ssl.match_hostname
Doc/whatsnew/3.2.rst:1650: WARNING: py:func reference target not found: ssl.wrap_socket
Doc/whatsnew/3.2.rst:1761: WARNING: py:class reference target not found: unittest.case.TestCase
Doc/whatsnew/3.2.rst:1799: WARNING: py:meth reference target not found: unittest.TestCase.assertRegexpMatches
Doc/whatsnew/3.2.rst:1816: WARNING: py:meth reference target not found: assert_
Doc/whatsnew/3.2.rst:1817: WARNING: py:meth reference target not found: assertEquals
Doc/whatsnew/3.2.rst:1818: WARNING: py:meth reference target not found: assertNotEquals
Doc/whatsnew/3.2.rst:1819: WARNING: py:meth reference target not found: assertAlmostEquals
Doc/whatsnew/3.2.rst:1820: WARNING: py:meth reference target not found: assertNotAlmostEquals
Doc/whatsnew/3.2.rst:1827: WARNING: py:meth reference target not found: unittest.TestCase.assertDictContainsSubset
Doc/whatsnew/3.2.rst:2000: WARNING: py:meth reference target not found: get
Doc/whatsnew/3.2.rst:2000: WARNING: py:meth reference target not found: setdefault
Doc/whatsnew/3.2.rst:2121: WARNING: py:class reference target not found: Pdb
Doc/whatsnew/3.2.rst:2397: WARNING: py:meth reference target not found: split
Doc/whatsnew/3.2.rst:2397: WARNING: py:meth reference target not found: rsplit
Doc/whatsnew/3.2.rst:2397: WARNING: py:meth reference target not found: splitlines
Doc/whatsnew/3.2.rst:2397: WARNING: py:meth reference target not found: replace
Doc/whatsnew/3.2.rst:2397: WARNING: py:meth reference target not found: rfind
Doc/whatsnew/3.2.rst:2397: WARNING: py:meth reference target not found: rindex
Doc/whatsnew/3.2.rst:2397: WARNING: py:meth reference target not found: rsplit
Doc/whatsnew/3.2.rst:2397: WARNING: py:meth reference target not found: rpartition
Doc/whatsnew/3.2.rst:2411: WARNING: py:meth reference target not found: array.repeat
Doc/whatsnew/3.2.rst:2411: WARNING: py:class reference target not found: BaseHTTPRequestHandler
Doc/whatsnew/3.2.rst:2565: WARNING: c:macro reference target not found: Py_VA_COPY
Doc/whatsnew/3.2.rst:2569: WARNING: c:func reference target not found: PySys_SetArgvEx
Doc/whatsnew/3.2.rst:2653: WARNING: py:meth reference target not found: array.tostring
Doc/whatsnew/3.2.rst:2653: WARNING: py:meth reference target not found: array.fromstring
Doc/whatsnew/3.2.rst:2653: WARNING: py:meth reference target not found: array.tobytes
Doc/whatsnew/3.2.rst:2653: WARNING: py:meth reference target not found: array.frombytes
Doc/whatsnew/3.2.rst:2667: WARNING: py:func reference target not found: sys.setfilesystemencoding
Doc/whatsnew/3.2.rst:2675: WARNING: py:func reference target not found: string.maketrans

📚 Documentation preview 📚: https://cpython-previews--115580.org.readthedocs.build/

Copy link
Member

@AlexWaygood AlexWaygood left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice! Just one question:

@@ -1336,7 +1336,7 @@ Decimal('1.100000000000000088817841970012523233890533447265625')
Fraction(2476979795053773, 2251799813685248)

Another useful change for the :mod:`decimal` module is that the
:attr:`Context.clamp` attribute is now public. This is useful in creating
:attr:`Context.clamp <decimal.Context>` attribute is now public. This is useful in creating
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Public... but apparently still undocumented? Should this maybe be left as is, and added to this list for now?

cpython/Doc/conf.py

Lines 273 to 279 in 318f219

# Attributes/methods/etc. that definitely should be documented better,
# but are deferred for now:
('py:attr', '__annotations__'),
('py:meth', '__missing__'),
('py:attr', '__wrapped__'),
('py:meth', 'index'), # list.index, tuple.index, etc.
]

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure, added!

Copy link
Member

@AlexWaygood AlexWaygood left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@hugovk hugovk merged commit 4dff48d into python:main Feb 17, 2024
23 checks passed
@hugovk hugovk deleted the docs-fix-sphinx-warnings-3.2 branch February 17, 2024 10:03
@miss-islington-app
Copy link

Thanks @hugovk for the PR 🌮🎉.. I'm working now to backport this PR to: 3.11, 3.12.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Feb 17, 2024
…115580)

(cherry picked from commit 4dff48d)

Co-authored-by: Hugo van Kemenade <[email protected]>
Co-authored-by: Alex Waygood <[email protected]>
@bedevere-app
Copy link

bedevere-app bot commented Feb 17, 2024

GH-115589 is a backport of this pull request to the 3.12 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.12 bug and security fixes label Feb 17, 2024
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Feb 17, 2024
…115580)

(cherry picked from commit 4dff48d)

Co-authored-by: Hugo van Kemenade <[email protected]>
Co-authored-by: Alex Waygood <[email protected]>
@bedevere-app
Copy link

bedevere-app bot commented Feb 17, 2024

GH-115590 is a backport of this pull request to the 3.11 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.11 only security fixes label Feb 17, 2024
hugovk added a commit that referenced this pull request Feb 17, 2024
… (#115589)

Co-authored-by: Hugo van Kemenade <[email protected]>
Co-authored-by: Alex Waygood <[email protected]>
hugovk added a commit that referenced this pull request Feb 17, 2024
… (#115590)

Co-authored-by: Hugo van Kemenade <[email protected]>
Co-authored-by: Alex Waygood <[email protected]>
woodruffw pushed a commit to woodruffw-forks/cpython that referenced this pull request Mar 4, 2024
diegorusso pushed a commit to diegorusso/cpython that referenced this pull request Apr 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir skip news
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants