Skip to content

Fix Sphinx warnings on unknown targets #107164

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

Closed
wants to merge 1 commit into from
Closed

Fix Sphinx warnings on unknown targets #107164

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
View file
Open in desktop
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
6 changes: 3 additions & 3 deletions Doc/c-api/arg.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -477,7 +477,7 @@ API Functions
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 @@ -518,9 +518,9 @@ Building values
When memory buffers are passed as parameters to supply data to build objects, as
for the ``s`` and ``s#`` formats, the required data is copied. Buffers provided
by the caller are never referenced by the objects created by
:c:func:`Py_BuildValue`. In other words, if your code invokes :c:func:`malloc`
:c:func:`Py_BuildValue`. In other words, if your code invokes :c:func:`!malloc`
Copy link
Contributor

Choose a reason for hiding this comment

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

This is not needed; malloc is in the nitignore list in Doc/conf.py.

Suggested change
:c:func:`Py_BuildValue`. In other words, if your code invokes :c:func:`!malloc`
:c:func:`Py_BuildValue`. In other words, if your code invokes :c:func:`malloc`

Copy link
Member Author

Choose a reason for hiding this comment

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

I saw warnings on this function on this documentation page. Maybe the PR was outdated, I don't recall the details.

I didn't know nitignore, that sounds very useful!

and passes the allocated memory to :c:func:`Py_BuildValue`, your code is
responsible for calling :c:func:`free` for that memory once
responsible for calling :c:func:`!free` for that memory once
Copy link
Contributor

Choose a reason for hiding this comment

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

Ditto. See Doc/conf.py

Suggested change
responsible for calling :c:func:`!free` for that memory once
responsible for calling :c:func:`free` for that memory once

:c:func:`Py_BuildValue` returns.

In the following description, the quoted form is the format unit; the entry in
Expand Down