-
-
Notifications
You must be signed in to change notification settings - Fork 32.1k
gh-107659: ctypes: Add docstrings for ctypes.pointer
and ctypes.POINTER
#107660
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
@erlend-aasland -- Unsure on correct practice here, I would normally apply backport labels for docs PRs, but as this introduces AC, it may not be correct to backport the change. What would you advise? A |
IIRC, we generally do not backport PRs that introduce Argument Clinic. |
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.
Some suggestions to the docstring text. (Remember to regenerate clinic after applying.)
Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
Thanks for the review! I've applied your suggestions :) Just wondering, since the docstrings were taken mostly verbatim from the docs, should we also update the docs (e.g. use the imperative there as well)? |
IMO, that would be an improvement. I'd do it in a follow-up PR, so we could backport through to 3.11. IMO, we should normalise the wording in the entire prose of that page, so one section at the time could make sense. |
FTR, I did a similar operation for the sqlite3 docs last year, though through multiple PRs. |
Thanks! |
Adds docstrings for
ctypes.pointer
andctypes.POINTER
and converts both functions to Argument Clinic.(First time using the AC so I apologize in advance if I missed something 😄 )
ctypes.pointer
andctypes.POINTER
#107659