Skip to content
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.

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

[3.11] gh-107298: Fix Sphinx warnings in the C API doc (GH-107302) #107373

Merged
merged 2 commits into from
Jul 28, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion Doc/c-api/apiabiversion.rst
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ See :ref:`stable` for a discussion of API and ABI stability across versions.

Use this for numeric comparisons, e.g. ``#if PY_VERSION_HEX >= ...``.

This version is also available via the symbol :data:`Py_Version`.
This version is also available via the symbol :c:var:`Py_Version`.

.. c:var:: const unsigned long Py_Version
Expand Down
2 changes: 1 addition & 1 deletion Doc/c-api/buffer.rst
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ the elements exposed by an :class:`array.array` can be multi-byte values.

An example consumer of the buffer interface is the :meth:`~io.BufferedIOBase.write`
method of file objects: any object that can export a series of bytes through
the buffer interface can be written to a file. While :meth:`write` only
the buffer interface can be written to a file. While :meth:`!write` only
needs read-only access to the internal contents of the object passed to it,
other methods such as :meth:`~io.BufferedIOBase.readinto` need write access
to the contents of their argument. The buffer interface allows objects to
Expand Down
24 changes: 12 additions & 12 deletions Doc/c-api/bytes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -67,39 +67,39 @@ called with a non-bytes parameter.
+-------------------+---------------+--------------------------------+
| Format Characters | Type | Comment |
+===================+===============+================================+
| :attr:`%%` | *n/a* | The literal % character. |
| ``%%`` | *n/a* | The literal % character. |
+-------------------+---------------+--------------------------------+
| :attr:`%c` | int | A single byte, |
| ``%c`` | int | A single byte, |
| | | represented as a C int. |
+-------------------+---------------+--------------------------------+
| :attr:`%d` | int | Equivalent to |
| ``%d`` | int | Equivalent to |
| | | ``printf("%d")``. [1]_ |
+-------------------+---------------+--------------------------------+
| :attr:`%u` | unsigned int | Equivalent to |
| ``%u`` | unsigned int | Equivalent to |
| | | ``printf("%u")``. [1]_ |
+-------------------+---------------+--------------------------------+
| :attr:`%ld` | long | Equivalent to |
| ``%ld`` | long | Equivalent to |
| | | ``printf("%ld")``. [1]_ |
+-------------------+---------------+--------------------------------+
| :attr:`%lu` | unsigned long | Equivalent to |
| ``%lu`` | unsigned long | Equivalent to |
| | | ``printf("%lu")``. [1]_ |
+-------------------+---------------+--------------------------------+
| :attr:`%zd` | :c:type:`\ | Equivalent to |
| ``%zd`` | :c:type:`\ | Equivalent to |
| | Py_ssize_t` | ``printf("%zd")``. [1]_ |
+-------------------+---------------+--------------------------------+
| :attr:`%zu` | size_t | Equivalent to |
| ``%zu`` | size_t | Equivalent to |
| | | ``printf("%zu")``. [1]_ |
+-------------------+---------------+--------------------------------+
| :attr:`%i` | int | Equivalent to |
| ``%i`` | int | Equivalent to |
| | | ``printf("%i")``. [1]_ |
+-------------------+---------------+--------------------------------+
| :attr:`%x` | int | Equivalent to |
| ``%x`` | int | Equivalent to |
| | | ``printf("%x")``. [1]_ |
+-------------------+---------------+--------------------------------+
| :attr:`%s` | const char\* | A null-terminated C character |
| ``%s`` | const char\* | A null-terminated C character |
| | | array. |
+-------------------+---------------+--------------------------------+
| :attr:`%p` | const void\* | The hex representation of a C |
| ``%p`` | const void\* | The hex representation of a C |
| | | pointer. Mostly equivalent to |
| | | ``printf("%p")`` except that |
| | | it is guaranteed to start with |
Expand Down
2 changes: 1 addition & 1 deletion Doc/c-api/cell.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Cell objects are not likely to be useful elsewhere.
The type object corresponding to cell objects.


.. c:function:: int PyCell_Check(ob)
.. c:function:: int PyCell_Check(PyObject *ob)

Return true if *ob* is a cell object; *ob* must not be ``NULL``. This
function always succeeds.
Expand Down
2 changes: 1 addition & 1 deletion Doc/c-api/gcsupport.rst
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ rules:

.. versionchanged:: 3.8

The :c:func:`_PyObject_GC_TRACK` and :c:func:`_PyObject_GC_UNTRACK` macros
The :c:func:`!_PyObject_GC_TRACK` and :c:func:`!_PyObject_GC_UNTRACK` macros
have been removed from the public C API.

The :c:member:`~PyTypeObject.tp_traverse` handler accepts a function parameter of this type:
Expand Down
4 changes: 2 additions & 2 deletions Doc/c-api/iterator.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ sentinel value is returned.
types.


.. c:function:: int PySeqIter_Check(op)
.. c:function:: int PySeqIter_Check(PyObject *op)

Return true if the type of *op* is :c:data:`PySeqIter_Type`. This function
always succeeds.
Expand All @@ -38,7 +38,7 @@ sentinel value is returned.
two-argument form of the :func:`iter` built-in function.


.. c:function:: int PyCallIter_Check(op)
.. c:function:: int PyCallIter_Check(PyObject *op)

Return true if the type of *op* is :c:data:`PyCallIter_Type`. This
function always succeeds.
Expand Down
2 changes: 1 addition & 1 deletion Doc/c-api/type.rst
Original file line number Diff line number Diff line change
Expand Up @@ -292,7 +292,7 @@ The following functions and structs are used to create
Setting :c:data:`Py_tp_bases` or :c:data:`Py_tp_base` may be
problematic on some platforms.
To avoid issues, use the *bases* argument of
:py:func:`PyType_FromSpecWithBases` instead.
:c:func:`PyType_FromSpecWithBases` instead.

.. versionchanged:: 3.9

Expand Down
2 changes: 1 addition & 1 deletion Doc/c-api/typehints.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ two types exist -- :ref:`GenericAlias <types-genericalias>` and
...
}

.. seealso:: The data model method :meth:`__class_getitem__`.
.. seealso:: The data model method :meth:`~object.__class_getitem__`.

.. versionadded:: 3.9

Expand Down
4 changes: 2 additions & 2 deletions Doc/c-api/unicode.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1306,7 +1306,7 @@ This codec is special in that it can be used to implement many different codecs
(and this is in fact what was done to obtain most of the standard codecs
included in the :mod:`encodings` package). The codec uses mappings to encode and
decode characters. The mapping objects provided must support the
:meth:`__getitem__` mapping interface; dictionaries and sequences work well.
:meth:`~object.__getitem__` mapping interface; dictionaries and sequences work well.

These are the mapping codec APIs:

Expand Down Expand Up @@ -1349,7 +1349,7 @@ The following codec API is special in that maps Unicode to Unicode.
The mapping table must map Unicode ordinal integers to Unicode ordinal integers
or ``None`` (causing deletion of the character).

Mapping tables need only provide the :meth:`__getitem__` interface; dictionaries
Mapping tables need only provide the :meth:`~object.__getitem__` interface; dictionaries
and sequences work well. Unmapped character ordinals (ones which cause a
:exc:`LookupError`) are left untouched and are copied as-is.

Expand Down
8 changes: 4 additions & 4 deletions Doc/c-api/weakref.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,18 +11,18 @@ simple reference object, and the second acts as a proxy for the original object
as much as it can.


.. c:function:: int PyWeakref_Check(ob)
.. c:function:: int PyWeakref_Check(PyObject *ob)

Return true if *ob* is either a reference or proxy object. This function
always succeeds.


.. c:function:: int PyWeakref_CheckRef(ob)
.. c:function:: int PyWeakref_CheckRef(PyObject *ob)

Return true if *ob* is a reference object. This function always succeeds.


.. c:function:: int PyWeakref_CheckProxy(ob)
.. c:function:: int PyWeakref_CheckProxy(PyObject *ob)

Return true if *ob* is a proxy object. This function always succeeds.

Expand Down Expand Up @@ -54,7 +54,7 @@ as much as it can.
.. c:function:: PyObject* PyWeakref_GetObject(PyObject *ref)

Return the referenced object from a weak reference, *ref*. If the referent is
no longer live, returns :const:`Py_None`.
no longer live, returns ``Py_None``.

.. note::

Expand Down