Skip to content

gh-107689: add docstrings to abstract classes #108882

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
ambv merged 2 commits into from
Oct 20, 2026
+20 −2
Merged

gh-107689: add docstrings to abstract classes #108882

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7feffc2
add docstrings to abstract classes
kiblik1 Sep 4, 2023
168d8a9
📜🤖 Added by blurb_it.
blurb-it[bot] Sep 4, 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
1 change: 1 addition & 0 deletions Misc/NEWS.d/next/Documentation/2023-09-04-16-01-20.gh-issue-107689.LFLFtG.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Added docstrings to abstract ctypes.
21 changes: 19 additions & 2 deletions Modules/_ctypes/_ctypes.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5545,7 +5545,12 @@ Simple_repr(PyObject *self)

static PyType_Slot pycsimple_slots[] = {
{Py_tp_repr, &Simple_repr},
{Py_tp_doc, PyDoc_STR("XXX to be provided")},
{Py_tp_doc, PyDoc_STR("This non-public class is the base class of all "
"fundamental ctypes data types.\n"
"It contains the common attributes of the fundamental "
"ctypes data types.\n"
"_SimpleCData is a subclass of _CData, so it inherits "
"their methods and attributes.")},
{Py_tp_methods, Simple_methods},
{Py_tp_getset, Simple_getsets},
{Py_tp_init, Simple_init},
Expand Down Expand Up @@ -5986,7 +5991,19 @@ Pointer_bool(PyObject *self)
}

static PyType_Slot pycpointer_slots[] = {
{Py_tp_doc, (void *)PyDoc_STR("XXX to be provided")},
{Py_tp_doc, (void *)PyDoc_STR(
"Private, abstract base class for pointers.\n"
"\n"
"Concrete pointer types are created by calling POINTER() "
"with the type that will be pointed to; this is done "
"automatically by pointer().\n"
"\n"
"If a pointer points to an array, its elements can be read "
"and written using standard subscript and slice accesses. "
"Pointer objects have no size, so len() will raise "
"TypeError. Negative subscripts will read from the memory "
"before the pointer (as in C), and out-of-range subscripts "
"will probably crash with an access violation (if you’re lucky).")},
{Py_tp_getset, Pointer_getsets},
{Py_tp_init, Pointer_init},
{Py_tp_new, Pointer_new},
Expand Down
Loading