[Python-checkins] gh-97909: Fix markup for `PyMethodDef` members (GH-100089)
miss-islington
webhook-mailer at python.org
Sat Dec 17 02:19:50 EST 2022
https://github.com/python/cpython/commit/370498b12ee9ce9edb93da0498a5cec1806147fc
commit: 370498b12ee9ce9edb93da0498a5cec1806147fc
branch: 3.11
author: Miss Islington (bot) <31488909+miss-islington at users.noreply.github.com>
committer: miss-islington <31488909+miss-islington at users.noreply.github.com>
date: 2022-12-16T23:19:45-08:00
summary:
gh-97909: Fix markup for `PyMethodDef` members (GH-100089)
(cherry picked from commit 8edcb30c3f8bdd8099a093146fedbd9b63a3f667)
Co-authored-by: ram vikram singh <ramvikrams243 at gmail.com>
files:
M Doc/c-api/structures.rst
diff --git a/Doc/c-api/structures.rst b/Doc/c-api/structures.rst
index 2b5d9a84822b..30760c0db88c 100644
--- a/Doc/c-api/structures.rst
+++ b/Doc/c-api/structures.rst
@@ -247,29 +247,30 @@ Implementing functions and methods
Structure used to describe a method of an extension type. This structure has
four fields:
- +------------------+---------------+-------------------------------+
- | Field | C Type | Meaning |
- +==================+===============+===============================+
- | :attr:`ml_name` | const char \* | name of the method |
- +------------------+---------------+-------------------------------+
- | :attr:`ml_meth` | PyCFunction | pointer to the C |
- | | | implementation |
- +------------------+---------------+-------------------------------+
- | :attr:`ml_flags` | int | flag bits indicating how the |
- | | | call should be constructed |
- +------------------+---------------+-------------------------------+
- | :attr:`ml_doc` | const char \* | points to the contents of the |
- | | | docstring |
- +------------------+---------------+-------------------------------+
+ .. c:member:: const char* ml_name
+
+ name of the method
+
+ .. c:member:: PyCFunction ml_meth
+
+ pointer to the C implementation
+
+ .. c:member:: int ml_flags
+
+ flags bits indicating how the call should be constructed
+
+ .. c:member:: const char* ml_doc
+
+ points to the contents of the docstring
-The :attr:`ml_meth` is a C function pointer. The functions may be of different
+The :c:member:`ml_meth` is a C function pointer. The functions may be of different
types, but they always return :c:expr:`PyObject*`. If the function is not of
the :c:type:`PyCFunction`, the compiler will require a cast in the method table.
Even though :c:type:`PyCFunction` defines the first parameter as
:c:expr:`PyObject*`, it is common that the method implementation uses the
specific C type of the *self* object.
-The :attr:`ml_flags` field is a bitfield which can include the following flags.
+The :c:member:`ml_flags` field is a bitfield which can include the following flags.
The individual flags indicate either a calling convention or a binding
convention.
More information about the Python-checkins
mailing list