gh-101100: Fix most Sphinx nitpicks in inspect.rst
#112662
Merged
+19
−9
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
AlexWaygood
added
needs backport to 3.11
bedevere-app
bot
added
docs
Member
What do you think about putting this in |
Member
Author
That makes sense to me; I'll make the change! |
|
Thanks @AlexWaygood 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
Dec 3, 2023
…112662) (cherry picked from commit 45650d1) Co-authored-by: Alex Waygood <[email protected]>
|
GH-112666 is a backport of this pull request to the 3.12 branch. |
|
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
…112662) (cherry picked from commit 45650d1) Co-authored-by: Alex Waygood <[email protected]>
AlexWaygood
added a commit
that referenced
this pull request
Dec 3, 2023
… (#112667) gh-101100: Fix most Sphinx nitpicks in `inspect.rst` (GH-112662) (cherry picked from commit 45650d1) Co-authored-by: Alex Waygood <[email protected]>
AlexWaygood
added a commit
that referenced
this pull request
Dec 3, 2023
… (#112666) gh-101100: Fix most Sphinx nitpicks in `inspect.rst` (GH-112662) (cherry picked from commit 45650d1) Co-authored-by: Alex Waygood <[email protected]>
aisk
pushed a commit
to aisk/cpython
that referenced
this pull request
Feb 11, 2024
Glyphack
pushed a commit
to Glyphack/cpython
that referenced
this pull request
Sep 2, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
__getattribute__(),__getattr__()and__dir__()__doc__attribute.type.__doc__,function.__doc__andmodule.__doc__are all documented in separate places; it's not clear which would be best to link to here.inspect.getargspec. It's deprecated, and it was never documented.__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.rstafter this PR: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/