-
-
Notifications
You must be signed in to change notification settings - Fork 32.1k
gh-107659: Improve wording of the description of ctypes.pointer
and ctypes.POINTER
#107769
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
ctypes.pointer and
ctypes.POINTER`ctypes.pointer
and ctypes.POINTER
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.
Thank you!
A
ctypes.pointer
and ctypes.POINTER
ctypes.pointer
and ctypes.POINTER
Thanks @tomasr8 for the PR, and @kumaraditya303 for merging it 🌮🎉.. I'm working now to backport this PR to: 3.11, 3.12. |
…r` and `ctypes.POINTER` (pythonGH-107769) (cherry picked from commit beffb30) Co-authored-by: Tomas R <[email protected]> Co-authored-by: Adam Turner <[email protected]> Co-authored-by: Kumar Aditya <[email protected]>
GH-108163 is a backport of this pull request to the 3.12 branch. |
GH-108164 is a backport of this pull request to the 3.11 branch. |
…r` and `ctypes.POINTER` (pythonGH-107769) (cherry picked from commit beffb30) Co-authored-by: Tomas R <[email protected]> Co-authored-by: Adam Turner <[email protected]> Co-authored-by: Kumar Aditya <[email protected]>
…er` and `ctypes.POINTER` (GH-107769) (#108164) gh-107659: Improve wording of the description of `ctypes.pointer` and `ctypes.POINTER` (GH-107769) (cherry picked from commit beffb30) Co-authored-by: Tomas R <[email protected]> Co-authored-by: Adam Turner <[email protected]> Co-authored-by: Kumar Aditya <[email protected]>
…er` and `ctypes.POINTER` (GH-107769) (#108163) gh-107659: Improve wording of the description of `ctypes.pointer` and `ctypes.POINTER` (GH-107769) (cherry picked from commit beffb30) Co-authored-by: Tomas R <[email protected]> Co-authored-by: Adam Turner <[email protected]> Co-authored-by: Kumar Aditya <[email protected]>
In a previous PR, docstrings for these two methods were added. The description from the docs was used for the docstrings with some small improvements. It was discussed that we could apply these improvements to the docs as well so that they stay in sync: #107660 (comment)
The change is mostly to use the imperative mode when describing the functions and dropping some redundant words. I also updated the function signature.
I think neither an issue or a NEWS entry is required since this is a small change, but let me know if that's not the case :)
📚 Documentation preview 📚: https://cpython-previews--107769.org.readthedocs.build/
ctypes.pointer
andctypes.POINTER
#107659