Skip to content

gh-107659: ctypes: Add docstrings for ctypes.pointer and ctypes.POINTER - #107660

Merged
erlend-aasland merged 9 commits into
python:mainfrom
tomasr8:ctypes-pointer
Aug 8, 2023
Merged

gh-107659: ctypes: Add docstrings for ctypes.pointer and ctypes.POINTER#107660
erlend-aasland merged 9 commits into
python:mainfrom
tomasr8:ctypes-pointer

Conversation

@tomasr8

@tomasr8tomasr8 commented Aug 5, 2023

Copy link
Copy Markdown
Member

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 😄 )

Comment threadModules/_ctypes/callproc.c Outdated
@AA-TurnerAA-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
Copy Markdown
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

Comment threadModules/_ctypes/callproc.c Outdated
@erlend-aasland

Copy link
Copy Markdown
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-aaslanderlend-aasland removed needs backport to 3.11 only security fixes needs backport to 3.12 only security fixes labels Aug 5, 2023

@erlend-aaslanderlend-aasland left a comment

Copy link
Copy Markdown
Contributor

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.)

Comment threadModules/_ctypes/callproc.c Outdated
Comment threadModules/_ctypes/callproc.c Outdated
Comment threadModules/_ctypes/callproc.c Outdated
Comment threadModules/_ctypes/callproc.c Outdated
tomasr8and 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
Copy Markdown
MemberAuthor

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
Copy Markdown
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
Copy Markdown
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 enabled auto-merge (squash) August 8, 2023 07:41
@erlend-aasland

Copy link
Copy Markdown
Contributor

Thanks!

Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docsDocumentation in the Doc dir

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants

@tomasr8@AA-Turner@erlend-aasland@chgnrdv@bedevere-bot