Mirror
/
cpython
mirror of https://github.com/python/cpython
4
1
Fork 0
Code Issues Releases Wiki Activity

gh-107298: Docs: add targets for some :c:member: and :c:macro: references (GH-107316) 

Add targets for PyStructSequence_Desc and PyStructSequence_Field members
and macros like Py_EQ.
Fix target for Py_RETURN_RICHCOMPARE.
This commit is contained in:
Serhiy Storchaka 2023-07-27 09:04:02 +03:00 committed by GitHub
parent d363eb5b02
commit abec9a1b20
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 40 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
Doc/c-api/tuple.rst
View File

@ -147,20 +147,21 @@ type.
Contains the meta information of a struct sequence type to create.
+-------------------+------------------------------+--------------------------------------+
| Field | C Type | Meaning |
+===================+==============================+======================================+
| ``name`` | ``const char *`` | name of the struct sequence type |
+-------------------+------------------------------+--------------------------------------+
| ``doc`` | ``const char *`` | pointer to docstring for the type |
| | | or ``NULL`` to omit |
+-------------------+------------------------------+--------------------------------------+
| ``fields`` | ``PyStructSequence_Field *`` | pointer to ``NULL``-terminated array |
| | | with field names of the new type |
+-------------------+------------------------------+--------------------------------------+
| ``n_in_sequence`` | ``int`` | number of fields visible to the |
| | | Python side (if used as tuple) |
+-------------------+------------------------------+--------------------------------------+
.. c:member:: const char *name
Name of the struct sequence type.
.. c:member:: const char *doc
Pointer to docstring for the type or ``NULL`` to omit.
.. c:member:: PyStructSequence_Field *fields
Pointer to ``NULL``-terminated array with field names of the new type.
.. c:member:: int n_in_sequence
Number of fields visible to the Python side (if used as tuple).
.. c:type:: PyStructSequence_Field
@ -171,16 +172,14 @@ type.
the :c:type:`PyStructSequence_Desc` determines which
field of the struct sequence is described.
+-----------+------------------+-----------------------------------------+
| Field | C Type | Meaning |
+===========+==================+=========================================+
| ``name`` | ``const char *`` | name for the field or ``NULL`` to end |
| | | the list of named fields, set to |
| | | :c:data:`PyStructSequence_UnnamedField` |
| | | to leave unnamed |
+-----------+------------------+-----------------------------------------+
| ``doc`` | ``const char *`` | field docstring or ``NULL`` to omit |
+-----------+------------------+-----------------------------------------+
.. c:member:: const char *name
Name for the field or ``NULL`` to end the list of named fields,
set to :c:data:`PyStructSequence_UnnamedField` to leave unnamed.
.. c:member:: const char *doc
Field docstring or ``NULL`` to omit.
.. c:var:: const char * const PyStructSequence_UnnamedField

32
Doc/c-api/typeobj.rst
View File

@ -1513,21 +1513,23 @@ and :c:data:`PyType_Type` effectively act as defaults.)
The following constants are defined to be used as the third argument for
:c:member:`~PyTypeObject.tp_richcompare` and for :c:func:`PyObject_RichCompare`:
+------------------+------------+
| Constant | Comparison |
+==================+============+
| :c:macro:`Py_LT` | ``<`` |
+------------------+------------+
| :c:macro:`Py_LE` | ``<=`` |
+------------------+------------+
| :c:macro:`Py_EQ` | ``==`` |
+------------------+------------+
| :c:macro:`Py_NE` | ``!=`` |
+------------------+------------+
| :c:macro:`Py_GT` | ``>`` |
+------------------+------------+
| :c:macro:`Py_GE` | ``>=`` |
+------------------+------------+
.. c:namespace:: NULL
+--------------------+------------+
| Constant | Comparison |
+====================+============+
| .. c:macro:: Py_LT | ``<`` |
+--------------------+------------+
| .. c:macro:: Py_LE | ``<=`` |
+--------------------+------------+
| .. c:macro:: Py_EQ | ``==`` |
+--------------------+------------+
| .. c:macro:: Py_NE | ``!=`` |
+--------------------+------------+
| .. c:macro:: Py_GT | ``>`` |
+--------------------+------------+
| .. c:macro:: Py_GE | ``>=`` |
+--------------------+------------+
The following macro is defined to ease writing rich comparison functions:

1
Doc/tools/.nitignore
View File

@ -23,7 +23,6 @@ Doc/c-api/set.rst
Doc/c-api/stable.rst
Doc/c-api/structures.rst
Doc/c-api/sys.rst
Doc/c-api/tuple.rst
Doc/c-api/type.rst
Doc/c-api/typeobj.rst
Doc/c-api/unicode.rst