ctypes: Add docstring for `ctypes.Array`
Documentation
The Array class from the ctypes module doesn't have a proper docstring:
from ctypes import Array help(Array) >>> Help on class Array in module _ctypes: >>> >>> class Array(_CData) >>> | XXX to be provided # !! >>> |
Though the class is documented in the docs so we could just reuse that description.
Feel free to pick up this issue :) If you're new to the C internals, here's a small guide to help you get started:
ctypes.Array is a class implemented in C defined in Modules/_ctypes/_ctypes.c. Here is the current docstring definition:
| Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */ | |
| PyDoc_STR("XXX to be provided"), /* tp_doc */ | |
| (traverseproc)PyCData_traverse, /* tp_traverse */ |
To 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 to create a separate variable with the new docstring:
PyDoc_STRVAR(array_doc, "Abstract base class for arrays.\n" "\n" "The recommended way to create ...");
then you substitute it back instead of PyDoc_STR:
Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */ - PyDoc_STR("XXX to be provided"), /* tp_doc */ + array_doc, /* tp_doc */ (traverseproc)PyCData_traverse,
To test that it worked, rebuild python and check the docstring ;)