diff options
| author | Oleg Iarygin <oleg@arhadthedev.net> | 2022-04-18 03:39:32 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-04-18 03:39:32 (GMT) |
| commit | a573cb2fec664c645ab744658d7e941d72e1a398 (patch) | |
| tree | a44303e326da2ea7406397c6640cf0d51ab3eb43 /Doc/c-api | |
| parent | 328dbc051f84bd5fdf61101bb4fa61d85f8b7feb (diff) | |
| download | cpython-a573cb2fec664c645ab744658d7e941d72e1a398.zip cpython-a573cb2fec664c645ab744658d7e941d72e1a398.tar.gz cpython-a573cb2fec664c645ab744658d7e941d72e1a398.tar.bz2 | |
gh-91118: Fix docstrings that do not honor --without-doc-strings (#31769)
Co-authored-by: Éric <merwok@netwok.org>
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
Diffstat (limited to 'Doc/c-api')
| -rw-r--r-- | Doc/c-api/typeobj.rst | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/Doc/c-api/typeobj.rst b/Doc/c-api/typeobj.rst index 4a54139..ed434d8 100644 --- a/Doc/c-api/typeobj.rst +++ b/Doc/c-api/typeobj.rst @@ -2597,7 +2597,7 @@ A basic :ref:`static type <static-types>`:: PyVarObject_HEAD_INIT(NULL, 0) .tp_name = "mymod.MyObject", .tp_basicsize = sizeof(MyObject), - .tp_doc = "My objects", + .tp_doc = PyDoc_STR("My objects"), .tp_new = myobj_new, .tp_dealloc = (destructor)myobj_dealloc, .tp_repr = (reprfunc)myobj_repr, @@ -2627,7 +2627,7 @@ with a more verbose initializer:: 0, /* tp_setattro */ 0, /* tp_as_buffer */ 0, /* tp_flags */ - "My objects", /* tp_doc */ + PyDoc_STR("My objects"), /* tp_doc */ 0, /* tp_traverse */ 0, /* tp_clear */ 0, /* tp_richcompare */ @@ -2660,7 +2660,7 @@ A type that supports weakrefs, instance dicts, and hashing:: PyVarObject_HEAD_INIT(NULL, 0) .tp_name = "mymod.MyObject", .tp_basicsize = sizeof(MyObject), - .tp_doc = "My objects", + .tp_doc = PyDoc_STR("My objects"), .tp_weaklistoffset = offsetof(MyObject, weakreflist), .tp_dictoffset = offsetof(MyObject, inst_dict), .tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | Py_TPFLAGS_HAVE_GC, @@ -2688,7 +2688,7 @@ to create instances (e.g. uses a separate factory func) using .tp_name = "mymod.MyStr", .tp_basicsize = sizeof(MyStr), .tp_base = NULL, // set to &PyUnicode_Type in module init - .tp_doc = "my custom str", + .tp_doc = PyDoc_STR("my custom str"), .tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_DISALLOW_INSTANTIATION, .tp_repr = (reprfunc)myobj_repr, }; |