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

Fix Sphinx warnings in C API doc #107274

Closed
wants to merge 1 commit into from
Closed
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`.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See #107091. It is discussed whether we should use :c:var: or :c:data:.

#107063 also fixes this line.


.. c:var:: const unsigned long Py_Version
Expand Down
2 changes: 1 addition & 1 deletion Doc/c-api/arg.rst
Original file line number Diff line number Diff line change
Expand Up @@ -404,7 +404,7 @@
raises the appropriate exception.


.. c:function:: int PyArg_VaParse(PyObject *args, const char *format, va_list vargs)

Check warning on line 407 in Doc/c-api/arg.rst

View workflow job for this annotation

GitHub Actions / Docs / Docs

c:identifier reference target not found: va_list

Check warning on line 407 in Doc/c-api/arg.rst

View workflow job for this annotation

GitHub Actions / Docs / Docs

c:identifier reference target not found: va_list

Identical to :c:func:`PyArg_ParseTuple`, except that it accepts a va_list rather
than a variable number of arguments.
Expand All @@ -424,7 +424,7 @@
<positional-only_parameter>`.


.. c:function:: int PyArg_VaParseTupleAndKeywords(PyObject *args, PyObject *kw, const char *format, char *keywords[], va_list vargs)

Check warning on line 427 in Doc/c-api/arg.rst

View workflow job for this annotation

GitHub Actions / Docs / Docs

c:identifier reference target not found: va_list

Check warning on line 427 in Doc/c-api/arg.rst

View workflow job for this annotation

GitHub Actions / Docs / Docs

c:identifier reference target not found: va_list

Identical to :c:func:`PyArg_ParseTupleAndKeywords`, except that it accepts a
va_list rather than a variable number of arguments.
Expand Down Expand Up @@ -477,7 +477,7 @@
will be set if there was a failure.

This is an example of the use of this function, taken from the sources for the
:mod:`_weakref` helper module for weak references::
:mod:`!_weakref` helper module for weak references::

static PyObject *
weakref_ref(PyObject *self, PyObject *args)
Expand Down Expand Up @@ -656,7 +656,7 @@
If there is an error in the format string, the :exc:`SystemError` exception is
set and ``NULL`` returned.

.. c:function:: PyObject* Py_VaBuildValue(const char *format, va_list vargs)

Check warning on line 659 in Doc/c-api/arg.rst

View workflow job for this annotation

GitHub Actions / Docs / Docs

c:identifier reference target not found: va_list

Check warning on line 659 in Doc/c-api/arg.rst

View workflow job for this annotation

GitHub Actions / Docs / Docs

c:identifier reference target not found: va_list

Identical to :c:func:`Py_BuildValue`, except that it accepts a va_list
rather than a variable number of arguments.
2 changes: 1 addition & 1 deletion Doc/c-api/bool.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ are available, however.

.. c:function:: int PyBool_Check(PyObject *o)

Return true if *o* is of type :c:data:`PyBool_Type`. This function always
Return true if *o* is of type :c:data:`!PyBool_Type`. This function always
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would not be better to add the documentation for PyBool_Type?

succeeds.


Expand Down
Loading