◐ Shell
reader mode source ↗
Skip to content

gh-101100: Fix most Sphinx nitpicks in inspect.rst#112662

Merged
AlexWaygood merged 3 commits into
python:mainfrom
AlexWaygood:sphinx-inspect-nitpicks
Dec 3, 2023
Merged

gh-101100: Fix most Sphinx nitpicks in inspect.rst#112662
AlexWaygood merged 3 commits into
python:mainfrom
AlexWaygood:sphinx-inspect-nitpicks

Conversation

@AlexWaygood

@AlexWaygood AlexWaygood commented Dec 3, 2023 •
edited
Loading

Copy link
Copy Markdown
Member
  • Fix links to the data-model entries for __getattribute__(), __getattr__() and __dir__()
  • Tell Sphinx not to try to create links for the __doc__ attribute. type.__doc__, function.__doc__ and module.__doc__ are all documented in separate places; it's not clear which would be best to link to here.
  • Across the whole documentation, tell Sphinx not to try to create links to inspect.getargspec. It's deprecated, and it was never documented.
  • Where the __func__ attribute is referenced, add links to the data-model docs on instance methods. The attribute is explained well there.

There's one nitpick warning remaining in inspect.rst after this PR:

cpython\Doc\library\inspect.rst:1167: WARNING: py:attr reference target not found: __wrapped__

We don't seem to have a good canonical description anywhere for the __wrapped__ attribute; we should add one. I'm deferring that task for now, since it requires a bit more effort than any of the other things I'm doing as part of this PR :)

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

@AlexWaygood AlexWaygood added needs backport to 3.11 only security fixes needs backport to 3.12 only security fixes labels Dec 3, 2023
@AlexWaygood AlexWaygood requested a review from hugovk December 3, 2023 14:52
@bedevere-app bedevere-app Bot added docs Documentation in the Doc dir skip news awaiting core review labels Dec 3, 2023
@bedevere-app bedevere-app Bot mentioned this pull request Dec 3, 2023
Open
@hugovk

hugovk commented Dec 3, 2023

Copy link
Copy Markdown
Member
  • Across the whole documentation, tell Sphinx not to try to create links to inspect.getargspec. It's deprecated, and it was never documented.

What do you think about putting this in nitpick_ignore in Doc.conf.py? Then it's only one line added instead of several changed (and some files not needing any change), plus future uses won't need the same ! treatment?

@AlexWaygood

AlexWaygood commented Dec 3, 2023

Copy link
Copy Markdown
Member Author
  • Across the whole documentation, tell Sphinx not to try to create links to inspect.getargspec. It's deprecated, and it was never documented.

What do you think about putting this in nitpick_ignore in Doc.conf.py? Then it's only one line added instead of several changed (and some files not needing any change), plus future uses won't need the same ! treatment?

That makes sense to me; I'll make the change!

hugovk
hugovk approved these changes Dec 3, 2023
View reviewed changes

@hugovk hugovk left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Hide comment

👍

@AlexWaygood AlexWaygood enabled auto-merge (squash) December 3, 2023 17:20
@AlexWaygood AlexWaygood disabled auto-merge December 3, 2023 17:21
@AlexWaygood AlexWaygood enabled auto-merge (squash) December 3, 2023 17:25
@AlexWaygood AlexWaygood disabled auto-merge December 3, 2023 17:26
@AlexWaygood AlexWaygood enabled auto-merge (squash) December 3, 2023 17:27
@AlexWaygood AlexWaygood merged commit 45650d1 into python:main Dec 3, 2023
@AlexWaygood AlexWaygood deleted the sphinx-inspect-nitpicks branch December 3, 2023 17:32
@miss-islington-app

miss-islington-app Bot commented Dec 3, 2023

Copy link
Copy Markdown

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

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Dec 3, 2023
@AlexWaygood @miss-islington
pythongh-101100: Fix most Sphinx nitpicks in inspect.rst (pythonGH-… …
f111047 
…112662)

(cherry picked from commit 45650d1)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
@bedevere-app

bedevere-app Bot commented Dec 3, 2023

Copy link
Copy Markdown

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

@bedevere-app bedevere-app Bot removed the needs backport to 3.12 only security fixes label Dec 3, 2023
@bedevere-app

bedevere-app Bot commented Dec 3, 2023

Copy link
Copy Markdown

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

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Dec 3, 2023
@AlexWaygood @miss-islington
pythongh-101100: Fix most Sphinx nitpicks in inspect.rst (pythonGH-… …
da5a3c4 
…112662)

(cherry picked from commit 45650d1)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
AlexWaygood added a commit that referenced this pull request Dec 3, 2023
@miss-islington @AlexWaygood
[3.11] gh-101100: Fix most Sphinx nitpicks in inspect.rst (GH-112662)… …
05ea7e5 
… (#112667)

gh-101100: Fix most Sphinx nitpicks in `inspect.rst` (GH-112662)
(cherry picked from commit 45650d1)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
AlexWaygood added a commit that referenced this pull request Dec 3, 2023
@miss-islington @AlexWaygood
[3.12] gh-101100: Fix most Sphinx nitpicks in inspect.rst (GH-112662)… …
5608112 
… (#112666)

gh-101100: Fix most Sphinx nitpicks in `inspect.rst` (GH-112662)
(cherry picked from commit 45650d1)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
aisk pushed a commit to aisk/cpython that referenced this pull request Feb 11, 2024
@AlexWaygood @aisk
pythongh-101100: Fix most Sphinx nitpicks in inspect.rst (python#11… …
db9fe84 
…2662)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@hugovk hugovk hugovk approved these changes

Assignees

No one assigned

Labels

docs Documentation in the Doc dir skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@AlexWaygood @hugovk