Uh oh!
There was an error while loading. Please reload this page.
gh-107659: ctypes: Add docstrings for ctypes.pointer and ctypes.POINTER - #107660
Conversation
Uh oh!
There was an error while loading. Please reload this page.
AA-Turner
commented
Aug 5, 2023
@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 |
Uh oh!
There was an error while loading. Please reload this page.
erlend-aasland
commented
Aug 5, 2023
IIRC, we generally do not backport PRs that introduce Argument Clinic. |
erlend-aasland
left a comment
There was a problem hiding this comment.
Some suggestions to the docstring text. (Remember to regenerate clinic after applying.)
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
tomasr8
commented
Aug 6, 2023
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)? |
erlend-aasland
commented
Aug 6, 2023
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. |
erlend-aasland
commented
Aug 6, 2023
FTR, I did a similar operation for the sqlite3 docs last year, though through multiple PRs. |
erlend-aasland
commented
Aug 8, 2023
Thanks! |
Adds docstrings for
ctypes.pointerandctypes.POINTERand converts both functions to Argument Clinic.(First time using the AC so I apologize in advance if I missed something 😄 )
ctypes.pointerandctypes.POINTER#107659