Skip to content

gh-107659: Add docstring for ctypes.POINTER & ctypes.ARRAY #107739

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

Closed
wants to merge 6 commits into from

Conversation

Geekverma
Copy link

@Geekverma Geekverma commented Aug 7, 2023

gh-107659:Add docstring for ctypes.POINTER & ctypes.ARRAY

@bedevere-bot

This comment was marked as resolved.

@ghost
Copy link

ghost commented Aug 7, 2023

All commit authors signed the Contributor License Agreement.
CLA signed

@Geekverma
Copy link
Author

@bedevere-bot how can i improve this test.

@bedevere-bot

This comment was marked as resolved.

@AlexWaygood AlexWaygood changed the title Add docstring for ctypes.POINTER & ctypes.ARRAY gh-107659: Add docstring for ctypes.POINTER & ctypes.ARRAY Aug 7, 2023
@Geekverma
Copy link
Author

Geekverma commented Aug 7, 2023

Hi @bedevere-bot I did not understand what to do with Misc/News.d file what to add there and on which file

@AlexWaygood
Copy link
Member

AlexWaygood commented Aug 7, 2023

Hi bot I did not understand what to do with Misc/News.d file what to add there and on which file

No news entry is required on a PR like this; I've applied the "skip news" label to this PR, and as a result, @bedevere-bot has stopped complaining about the lack of news entry.

Your PR appears to mean that Python no longer builds correctly, however, which is a more serious issue :)

@Geekverma
Copy link
Author

@AlexWaygood can i able to merge this, if not what to do

@@ -4814,7 +4816,13 @@ PyTypeObject PyCArray_Type = {
0, /* tp_setattro */
&PyCData_as_buffer, /* tp_as_buffer */
Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */
PyDoc_STR("XXX to be provided"), /* tp_doc */
PyDoc_STRVAR(array_doc,
Copy link
Contributor

@CharlieZhao95 CharlieZhao95 Aug 8, 2023

Choose a reason for hiding this comment

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

The error is here. Please take a look at the usage of PyDoc_STRVAR, you can search this in the source code of cpython :)

BTW. There is already a similar PR here.

@Geekverma
Copy link
Author

Geekverma commented Aug 8, 2023

Hi @CharlieZhao95 I fix the code as said, waiting for merging

@AA-Turner
Copy link
Member

In light of #107697 this only updates the comment for POINTER -- @Geekverma do you want to resolve conflicts and focus this PR on that?

A

@Geekverma
Copy link
Author

yes

@encukou
Copy link
Member

encukou commented Sep 17, 2024

#107660 added a docstring for ctypes.POINTER.
#107697 added a docstring for ctypes.Array.
ctypes.ARRAY still doesn't have a docstring, but this PR doesn't add one, and the function is soft-deprecated.

Sorry @Geekverma -- others were faster.

@encukou encukou closed this Sep 17, 2024
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.

6 participants