Skip to content

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

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
serhiy-storchaka merged 3 commits into from
Jul 28, 2023
Merged

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

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cf220d7
[3.12] gh-107298: Fix Sphinx warnings in the C API doc (GH-107302)
vstinner Jul 26, 2023
23e2a9c
Merge branch '3.12' into backport-391e03f-3.12
serhiy-storchaka Jul 28, 2023
6997a5b
Fix Doc/c-api/weakref.rst.
serhiy-storchaka Jul 28, 2023
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
Fix Doc/c-api/weakref.rst.
  • Loading branch information
@serhiy-storchaka
serhiy-storchaka committed Jul 28, 2023
commit 6997a5bc8d46901ba98b4ee00f9c4c21513d25cc
8 changes: 4 additions & 4 deletions Doc/c-api/weakref.rst
View file
Open in desktop
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