Thanks to visit codestin.com
Credit goes to github.com

Skip to content

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

Merged
merged 5 commits into from
Aug 20, 2023

Conversation

tomasr8
Copy link
Member

@tomasr8 tomasr8 commented Aug 8, 2023

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/

@bedevere-bot bedevere-bot added awaiting review docs Documentation in the Doc dir skip news labels Aug 8, 2023
@tomasr8 tomasr8 changed the title Docs: Improve wording of the description of ctypes.pointer and ctypes.POINTER` Docs: Improve wording of the description of ctypes.pointer and ctypes.POINTER Aug 8, 2023
Copy link
Member

@AA-Turner AA-Turner left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!

A

@AA-Turner AA-Turner changed the title Docs: Improve wording of the description of ctypes.pointer and ctypes.POINTER gh-107659: Improve wording of the description of ctypes.pointer and ctypes.POINTER Aug 11, 2023
@kumaraditya303 kumaraditya303 enabled auto-merge (squash) August 20, 2023 10:45
@kumaraditya303 kumaraditya303 merged commit beffb30 into python:main Aug 20, 2023
@miss-islington
Copy link
Contributor

Thanks @tomasr8 for the PR, and @kumaraditya303 for merging it 🌮🎉.. I'm working now to backport this PR to: 3.11, 3.12.
🐍🍒⛏🤖 I'm not a witch! I'm not a witch!

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 <[email protected]>
Co-authored-by: Adam Turner <[email protected]>
Co-authored-by: Kumar Aditya <[email protected]>
@bedevere-bot
Copy link

GH-108163 is a backport of this pull request to the 3.12 branch.

@bedevere-bot bedevere-bot removed the needs backport to 3.12 only security fixes label Aug 20, 2023
@bedevere-bot
Copy link

GH-108164 is a backport of this pull request to the 3.11 branch.

@bedevere-bot bedevere-bot removed the needs backport to 3.11 only security fixes label Aug 20, 2023
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 <[email protected]>
Co-authored-by: Adam Turner <[email protected]>
Co-authored-by: Kumar Aditya <[email protected]>
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 <[email protected]>
Co-authored-by: Adam Turner <[email protected]>
Co-authored-by: Kumar Aditya <[email protected]>
@tomasr8 tomasr8 deleted the ctypes-docs-pointer branch August 20, 2023 12:59
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 <[email protected]>
Co-authored-by: Adam Turner <[email protected]>
Co-authored-by: Kumar Aditya <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir skip news
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants