KEMBAR78
gh-107659: ctypes: Add docstrings for `ctypes.pointer` and `ctypes.POINTER` by tomasr8 · Pull Request #107660 · python/cpython · GitHub
Skip to content

Conversation

@tomasr8
Copy link
Member

@tomasr8 tomasr8 commented Aug 5, 2023

Adds docstrings for ctypes.pointer and ctypes.POINTER and converts both functions to Argument Clinic.
(First time using the AC so I apologize in advance if I missed something 😄 )

@AA-Turner AA-Turner added docs Documentation in the Doc dir needs backport to 3.11 only security fixes needs backport to 3.12 only security fixes labels Aug 5, 2023
@AA-Turner
Copy link
Member

@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

@erlend-aasland
Copy link
Contributor

@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?

IIRC, we generally do not backport PRs that introduce Argument Clinic.

@erlend-aasland erlend-aasland removed needs backport to 3.11 only security fixes needs backport to 3.12 only security fixes labels Aug 5, 2023
Copy link
Contributor

@erlend-aasland erlend-aasland left a 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.)

tomasr8 and others added 3 commits August 6, 2023 11:39
Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
@tomasr8
Copy link
Member Author

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
Copy link
Contributor

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.

@erlend-aasland
Copy link
Contributor

FTR, I did a similar operation for the sqlite3 docs last year, though through multiple PRs.

@erlend-aasland erlend-aasland enabled auto-merge (squash) August 8, 2023 07:41
@erlend-aasland erlend-aasland disabled auto-merge August 8, 2023 07:41
@erlend-aasland erlend-aasland enabled auto-merge (squash) August 8, 2023 07:41
@erlend-aasland
Copy link
Contributor

Thanks!

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants