Skip to content

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

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

Merged
merged 12 commits into from
Aug 10, 2023

Conversation

kostyafarber
Copy link
Contributor

@kostyafarber kostyafarber commented Aug 6, 2023

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

@bedevere-bot
Copy link

Most changes to Python require a NEWS entry.

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

@ghost
Copy link

ghost commented Aug 6, 2023

All commit authors signed the Contributor License Agreement.
CLA signed

AlexWaygood and others added 5 commits August 7, 2023 07:13
@kostyafarber kostyafarber requested a review from sunmy2019 August 7, 2023 06:14
@kostyafarber
Copy link
Contributor Author

@sunmy2019 done

@kostyafarber
Copy link
Contributor Author

@CharlieZhao95 any updates on this?

@CharlieZhao95
Copy link
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 :)

Copy link
Member

@sunmy2019 sunmy2019 left a comment

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

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