mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-10-03 05:35:59 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

gh-97909: Fix markup for PyMethodDef members (GH-100089)

Browse source 
(cherry picked from commit 8edcb30c3f)

Co-authored-by: ram vikram singh <ramvikrams243@gmail.com>
This commit is contained in:
Miss Islington (bot) 2022-12-16 23:19:45 -08:00 • committed by GitHub
parent e3d85783e5
commit 370498b12e
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 17 additions and 16 deletions
Download patch file Download diff file Expand all files Collapse all files

33
Doc/c-api/structures.rst
View file

@ -247,29 +247,30 @@ Implementing functions and methods
Structure used to describe a method of an extension type. This structure has Structure used to describe a method of an extension type. This structure has
four fields: four fields:
+------------------+---------------+-------------------------------+ .. c:member:: const char* ml_name
| 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 |
+------------------+---------------+-------------------------------+
The :attr:`ml_meth` is a C function pointer. The functions may be of different 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 :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 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. the :c:type:`PyCFunction`, the compiler will require a cast in the method table.
Even though :c:type:`PyCFunction` defines the first parameter as Even though :c:type:`PyCFunction` defines the first parameter as
:c:expr:`PyObject*`, it is common that the method implementation uses the :c:expr:`PyObject*`, it is common that the method implementation uses the
specific C type of the *self* object. 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 The individual flags indicate either a calling convention or a binding
convention. convention.