gh-107659: Improve wording of the description of ctypes.pointer and ctypes.POINTER
#107769
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
tomasr8
changed the title
ctypes.pointer and ctypes.POINTER`ctypes.pointer and ctypes.POINTER
AA-Turner
reviewed
Aug 11, 2023
AA-Turner
added
awaiting review
needs backport to 3.11
AA-Turner
changed the title
ctypes.pointer and ctypes.POINTERctypes.pointer and ctypes.POINTER
AA-Turner
reviewed
Aug 11, 2023
AA-Turner
reviewed
Aug 11, 2023
kumaraditya303
approved these changes
Aug 20, 2023
|
Thanks @tomasr8 for the PR, and @kumaraditya303 for merging it 🌮🎉.. 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
Aug 20, 2023
…r` and `ctypes.POINTER` (pythonGH-107769) (cherry picked from commit beffb30) Co-authored-by: Tomas R <tomas.roun8@gmail.com> Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Co-authored-by: Kumar Aditya <kumaraditya@python.org>
|
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. |
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this pull request
Aug 20, 2023
…r` and `ctypes.POINTER` (pythonGH-107769) (cherry picked from commit beffb30) Co-authored-by: Tomas R <tomas.roun8@gmail.com> Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Co-authored-by: Kumar Aditya <kumaraditya@python.org>
kumaraditya303
added a commit
that referenced
this pull request
Aug 20, 2023
…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 <tomas.roun8@gmail.com> Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Co-authored-by: Kumar Aditya <kumaraditya@python.org>
Yhg1s
pushed a commit
that referenced
this pull request
Aug 20, 2023
…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 <tomas.roun8@gmail.com> Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Co-authored-by: Kumar Aditya <kumaraditya@python.org>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 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.
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.pointerandctypes.POINTER#107659