-
-
Notifications
You must be signed in to change notification settings - Fork 30.8k
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 most Sphinx nitpicks in inspect.rst
#112662
Conversation
What do you think about putting this in |
That makes sense to me; I'll make the change! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍
Thanks @AlexWaygood for the PR 🌮🎉.. I'm working now to backport this PR to: 3.11, 3.12. |
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. |
__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.rst
after 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/