Skip to content
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.

Sign up for GitHub

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

Jump to bottom

ctypes: Add docstrings for ctypes.pointer and ctypes.POINTER #107659

Open
tomasr8 opened this issue Aug 5, 2023 · 0 comments
Open

ctypes: Add docstrings for ctypes.pointer and ctypes.POINTER #107659

tomasr8 opened this issue Aug 5, 2023 · 0 comments
Labels
3.11 only security fixes 3.12 bugs and security fixes 3.13 new features, bugs and security fixes docs Documentation in the Doc dir topic-ctypes type-feature A feature request or enhancement

Comments

@tomasr8
Copy link
Contributor

tomasr8 commented Aug 5, 2023 •
edited by bedevere-bot

ctypes.pointer and ctypes.POINTER from the ctypes module are currently lacking docstrings. I suggest we add those.
Luckily, these functions are already documented in the docs so it should just be a matter of reusing the description from the docs.
It has also been recommended that we convert both functions to Argument Clinic when adding the docstrings.

Linked PRs
@tomasr8 tomasr8 added the type-feature A feature request or enhancement label Aug 5, 2023
@bedevere-bot bedevere-bot mentioned this issue Aug 5, 2023
Merged
@AA-Turner AA-Turner added docs Documentation in the Doc dir 3.11 only security fixes 3.12 bugs and security fixes 3.13 new features, bugs and security fixes labels Aug 5, 2023
@Geekverma Geekverma mentioned this issue Aug 7, 2023
Open
erlend-aasland pushed a commit that referenced this issue Aug 8, 2023
@tomasr8
gh-107659: Add docstrings for ctypes.pointer and ctypes.POINTER (#107660
de72677 
)
@bedevere-bot bedevere-bot mentioned this issue Aug 11, 2023
Merged
kumaraditya303 added a commit that referenced this issue Aug 20, 2023
@tomasr8 @AA-Turner @kumaraditya303
gh-107659: Improve wording of the description of ctypes.pointer and…
beffb30 
… `ctypes.POINTER` (#107769)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Kumar Aditya <kumaraditya@python.org>
@bedevere-bot bedevere-bot mentioned this issue Aug 20, 2023
Merged
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Aug 20, 2023
@tomasr8 @AA-Turner
@kumaraditya303 @miss-islington
pythongh-107659: Improve wording of the description of `ctypes.pointe…
9db668f 
…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>
@bedevere-bot bedevere-bot mentioned this issue Aug 20, 2023
Merged
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Aug 20, 2023
@tomasr8 @AA-Turner
@kumaraditya303 @miss-islington
pythongh-107659: Improve wording of the description of `ctypes.pointe…
4956329 
…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 issue Aug 20, 2023
@miss-islington @tomasr8
@AA-Turner @kumaraditya303
[3.11] gh-107659: Improve wording of the description of `ctypes.point…
ba63706 
…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 issue Aug 20, 2023
@miss-islington @tomasr8
@AA-Turner @kumaraditya303
[3.12] gh-107659: Improve wording of the description of `ctypes.point…
590bc6a 
…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
Assignees
No one assigned
Labels
3.11 only security fixes 3.12 bugs and security fixes 3.13 new features, bugs and security fixes docs Documentation in the Doc dir topic-ctypes type-feature A feature request or enhancement
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@tomasr8 @AA-Turner @AlexWaygood