-
-
Notifications
You must be signed in to change notification settings - Fork 33.6k
gh-141004: Document descriptor and dict proxy type objects #141803
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
Conversation
|
Hi @ZeroIntensity, thanks for the review and apologies for the delay. I've addressed all the feedback:
All checks are passing. Please let me know if anything else needs adjustment. |
ZeroIntensity
left a comment
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.
Looks pretty good, a few final comments.
Doc/c-api/descriptor.rst
Outdated
| C struct as attributes on a type, and correspond to :class:`types.MemberDescriptorType` | ||
| objects in the Python layer. |
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.
We try to keep lines below 80 characters, but this line exceeds that limit. Same goes for a few lines below.
Co-authored-by: Peter Bierma <[email protected]>
vstinner
left a comment
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.
LGTM
Co-authored-by: Victor Stinner <[email protected]>
ZeroIntensity
left a comment
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.
LGTM as well, thanks!
|
Thanks @Yashp002 for the PR, and @ZeroIntensity for merging it 🌮🎉.. I'm working now to backport this PR to: 3.13, 3.14. |
…honGH-141803) (cherry picked from commit 52f9b5f) Co-authored-by: Yashraj <[email protected]> Co-authored-by: Peter Bierma <[email protected]> Co-authored-by: Victor Stinner <[email protected]>
…honGH-141803) (cherry picked from commit 52f9b5f) Co-authored-by: Yashraj <[email protected]> Co-authored-by: Peter Bierma <[email protected]> Co-authored-by: Victor Stinner <[email protected]>
|
GH-142147 is a backport of this pull request to the 3.14 branch. |
|
GH-142148 is a backport of this pull request to the 3.13 branch. |
…-141803) (GH142147) gh-141004: Document descriptor and dict proxy type objects (GH-141803) (cherry picked from commit 52f9b5f) Co-authored-by: Yashraj <[email protected]> Co-authored-by: Peter Bierma <[email protected]> Co-authored-by: Victor Stinner <[email protected]>
…-141803) (GH-142148) gh-141004: Document descriptor and dict proxy type objects (GH-141803) (cherry picked from commit 52f9b5f) Co-authored-by: Yashraj <[email protected]> Co-authored-by: Peter Bierma <[email protected]> Co-authored-by: Victor Stinner <[email protected]>
|
Thanks @ZeroIntensity for the guidance :) |
…honGH-141803) Co-authored-by: Peter Bierma <[email protected]> Co-authored-by: Victor Stinner <[email protected]>
This PR adds C API documentation for six previously undocumented type objects:
In
Doc/c-api/descriptor.rst:PyClassMethodDescr_Type- type for class method descriptorsPyGetSetDescr_Type- type for get/set descriptorsPyMemberDescr_Type- type for member descriptorsPyMethodDescr_Type- type for method descriptorsPyWrapperDescr_Type- type for wrapper descriptorsIn
Doc/c-api/dict.rst:PyDictProxy_Type- type for mapping proxy objectsEach entry follows the existing documentation style and includes a brief description of the type's purpose and its relationship to the Python layer.
Contributes to #141004.
📚 Documentation preview 📚: https://cpython-previews--141803.org.readthedocs.build/