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.

Sign up for GitHub

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
Merged

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

Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
32cd414
add docs to ctypes array
kostyafarber Aug 6, 2023
af53ee8
📜🤖 Added by blurb_it.
blurb-it[bot] Aug 6, 2023
7cc52a6
fix linting
kostyafarber Aug 6, 2023
0c14eef
gh-106368: Improve coverage reports for argument clinic (#107693)
AlexWaygood Aug 6, 2023
bc3d1eb
Improve cross-references in `runpy` docs (#107673)
kamilturek Aug 6, 2023
11d079b
Docs: Argument Clinic: Move the CConverter class to the reference (#1…
erlend-aasland Aug 7, 2023
42eac16
fix line width on docstring
kostyafarber Aug 7, 2023
1b0f5b1
Update Misc/NEWS.d/next/Documentation/2023-08-06-15-34-11.gh-issue-10…
kostyafarber Aug 7, 2023
80a3044
Merge branch 'main' into add-help-docs-to-ctype-array
kostyafarber Aug 7, 2023
a1ac1aa
Update Modules/_ctypes/_ctypes.c
kostyafarber Aug 7, 2023
b5b174f
Merge branch 'main' into add-help-docs-to-ctype-array
kostyafarber Aug 9, 2023
c117a42
Delete 2023-08-06-15-34-11.gh-issue-107689.oL193x.rst
kumaraditya303 Aug 10, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 12 additions & 2 deletions Modules/_ctypes/_ctypes.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4793,6 +4793,16 @@ static PyMappingMethods Array_as_mapping = {
Array_ass_subscript,
};

PyDoc_STRVAR(array_doc,
"Abstract base class for arrays.\n"
"\n"
"The recommended way to create concrete array types is by multiplying any\n"
"ctypes data type with a non-negative integer. Alternatively, you can subclass\n"
"this type and define _length_ and _type_ class variables. Array elements can\n"
"be read and written using standard subscript and slice accesses for slice\n"
"reads, the resulting object is not itself an Array."
);

PyTypeObject PyCArray_Type = {
PyVarObject_HEAD_INIT(NULL, 0)
"_ctypes.Array",
Expand All @@ -4813,8 +4823,8 @@ PyTypeObject PyCArray_Type = {
0, /* tp_getattro */
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 */
Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */
array_doc, /* tp_doc */
(traverseproc)PyCData_traverse, /* tp_traverse */
(inquiry)PyCData_clear, /* tp_clear */
0, /* tp_richcompare */
Expand Down