Skip to content

gh-97909: Fix markup for PyMethodDef members #100089

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
kumaraditya303 merged 6 commits into from
Dec 17, 2022
+18 −17
Merged

gh-97909: Fix markup for PyMethodDef members #100089

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
b34af05
updated the writing style PyMethodDef
ramvikrams Dec 7, 2022
32786ed
Update structures.rst
ramvikrams Dec 7, 2022
f87e767
Update structures.rst
ramvikrams Dec 7, 2022
24a0095
Update structures.rst
ramvikrams Dec 9, 2022
0d7fa54
Merge branch 'python:main' into t11
ramvikrams Dec 10, 2022
7d404d0
Merge branch 'main' into t11
kumaraditya303 Dec 17, 2022
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
Prev Previous commit
Next Next commit
Update structures.rst
  • Loading branch information
@ramvikrams
ramvikrams committed Dec 9, 2022
commit 24a009517d5e27c4e458e549c30d4064ccd0eb35
12 changes: 6 additions & 6 deletions Doc/c-api/structures.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -228,30 +228,30 @@ Implementing functions and methods
Structure used to describe a method of an extension type. This structure has
four fields:

.. c:member:: const char* PyMethodDef.ml_name
.. c:member:: const char* ml_name

name of the method

.. c:member:: PyCFunction PyMethodDef.ml_meth
.. c:member:: PyCFunction ml_meth

pointer to the C implementation

.. c:member:: int PyMethodDef.ml_flags
.. c:member:: int ml_flags

flags bits indicating how the call should be constructed

.. c:member:: const char* PyMethodDef.ml_doc
.. c:member:: const char* ml_doc

points to the contents of the docstring

The :c:member:`PyMethodDef.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 :c:member:`PyMethodDef.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.

Expand Down