Skip to content

gh-107689: Add docstring to the ctypes array object#107697

Merged
kumaraditya303 merged 12 commits into
python:mainfrom
kostyafarber:add-help-docs-to-ctype-array
Aug 10, 2023
Merged

gh-107689: Add docstring to the ctypes array object#107697
kumaraditya303 merged 12 commits into
python:mainfrom
kostyafarber:add-help-docs-to-ctype-array

Conversation

@kostyafarber

@kostyafarber kostyafarber commented Aug 6, 2023

Copy link
Copy Markdown
Contributor

Add a docstring to the ctypes array object. Docs from here were used.

@bedevere-bot

Copy link
Copy Markdown

Most changes to Python require a NEWS entry.

Please add it using the blurb_it web app or the blurb command-line tool.

@ghost

ghost commented Aug 6, 2023

Copy link
Copy Markdown

All commit authors signed the Contributor License Agreement.
CLA signed

Comment thread Misc/NEWS.d/next/Documentation/2023-08-06-15-34-11.gh-issue-107689.oL193x.rst Outdated
Comment thread Modules/_ctypes/_ctypes.c Outdated
AlexWaygood and others added 5 commits August 7, 2023 07:13
- Add links to `__main__` and `sys.path` where appropriate
- Ensure each paragraph never has more than one link to the same thing, to avoid visual clutter from too many links
…7689.oL193x.rst

Co-authored-by: sunmy2019 <59365878+sunmy2019@users.noreply.github.com>
@kostyafarber kostyafarber requested a review from sunmy2019 August 7, 2023 06:14
@kostyafarber

Copy link
Copy Markdown
Contributor Author

@sunmy2019 done

Comment thread Modules/_ctypes/_ctypes.c Outdated
Co-authored-by: Charlie Zhao <zhaoyu_hit@qq.com>
@kostyafarber

Copy link
Copy Markdown
Contributor Author

@CharlieZhao95 any updates on this?

@CharlieZhao95

Copy link
Copy Markdown
Contributor

@CharlieZhao95 any updates on this?

Thanks! Just a little reminder. The docstrings I've seen usually describe functions in the form of "what does this function can do", just like:

function A
Return True if xxx. If xxx, return False.

And it's rare to see "how can we use this function/type":

You could subclass type xxx.

This is probably not a problem that needs to be modified, I know this docstring comes from the official documentation. Aside from this, LGTM! Next step you could wait for review from core devs :)

@sunmy2019 sunmy2019 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LG! We shall wait for core devs now.

@bedevere-bot

Copy link
Copy Markdown

Most changes to Python require a NEWS entry.

Please add it using the blurb_it web app or the blurb command-line tool.

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

8 participants