René's URL Explorer Experiment

{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"ctypes: Add docstring for `ctypes.Array`","articleBody":"# Documentation\r\n\r\nThe [`Array` class](https://docs.python.org/3.13/library/ctypes.html#ctypes.Array) from the `ctypes` module doesn't have a proper docstring:\r\n\r\n```python\r\nfrom ctypes import Array\r\nhelp(Array)\r\n\r\n\u003e\u003e\u003e Help on class Array in module _ctypes:\r\n\u003e\u003e\u003e\r\n\u003e\u003e\u003e class Array(_CData)\r\n\u003e\u003e\u003e  |  XXX to be provided   # !!\r\n\u003e\u003e\u003e  |\r\n```\r\n\r\nThough the class is documented in the [docs](https://docs.python.org/3.13/library/ctypes.html#ctypes.Array) so we could just reuse that description.\r\n\r\nFeel free to pick up this issue :) If you're new to the C internals, here's a small guide to help you get started:\r\n\r\n`ctypes.Array` is a class implemented in C defined in `Modules/_ctypes/_ctypes.c`. Here is the current docstring definition:\r\n\r\nhttps://github.com/python/cpython/blob/71a7c96ffeb0d7fef06be3e57468896e030967a5/Modules/_ctypes/_ctypes.c#L4816-L4818\r\n\r\nTo update the docstring, we could simply change the argument of `PyDoc_STR(...)` but if the docstring is longer it's better to use [PyDoc_STRVAR](https://docs.python.org/3/c-api/intro.html#c.PyDoc_STRVAR) to create a separate variable with the new docstring:\r\n\r\n```c\r\nPyDoc_STRVAR(array_doc,\r\n\"Abstract base class for arrays.\\n\"\r\n\"\\n\"\r\n\"The recommended way to create ...\");\r\n```\r\nthen you substitute it back instead of `PyDoc_STR`:\r\n```diff\r\nPy_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */ \r\n- PyDoc_STR(\"XXX to be provided\"),        /* tp_doc */ \r\n+ array_doc,                              /* tp_doc */ \r\n(traverseproc)PyCData_traverse, \r\n```\r\n\r\nTo test that it worked, rebuild python and check the docstring ;)\r\n\r\n\n\n\u003c!-- gh-linked-prs --\u003e\n### Linked PRs\n* gh-107697\n* gh-108882\n\u003c!-- /gh-linked-prs --\u003e\n","author":{"url":"https://github.com/tomasr8","@type":"Person","name":"tomasr8"},"datePublished":"2023-08-06T10:56:35.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":7},"url":"https://github.com/107689/cpython/issues/107689"}