Skip to content

Commit 2de3897

Browse files
committed
Fix Sphinx warnings
Enhance also the doc: specific strong/borrowed reference
1 parent 4589377 commit 2de3897

File tree

1 file changed

+10
-9
lines changed

1 file changed

+10
-9
lines changed

Doc/c-api/weakref.rst

+10-9
Original file line numberDiff line numberDiff line change
@@ -11,20 +11,20 @@ simple reference object, and the second acts as a proxy for the original object
1111
as much as it can.
1212

1313

14-
.. c:function:: int PyWeakref_Check(ob)
14+
.. c:function:: int PyWeakref_Check(PyObject *ob)
1515
16-
Return true if *ob* is either a reference or proxy object. This function
16+
Return non-zero if *ob* is either a reference or proxy object. This function
1717
always succeeds.
1818
1919
20-
.. c:function:: int PyWeakref_CheckRef(ob)
20+
.. c:function:: int PyWeakref_CheckRef(PyObject *ob)
2121
22-
Return true if *ob* is a reference object. This function always succeeds.
22+
Return non-zero if *ob* is a reference object. This function always succeeds.
2323
2424
25-
.. c:function:: int PyWeakref_CheckProxy(ob)
25+
.. c:function:: int PyWeakref_CheckProxy(PyObject *ob)
2626
27-
Return true if *ob* is a proxy object. This function always succeeds.
27+
Return non-zero if *ob* is a proxy object. This function always succeeds.
2828
2929
3030
.. c:function:: PyObject* PyWeakref_NewRef(PyObject *ob, PyObject *callback)
@@ -53,7 +53,8 @@ as much as it can.
5353
5454
.. c:function:: int PyWeakref_GetRef(PyObject *ref, PyObject **pobj)
5555
56-
Get the referenced object from a weak reference, *ref*, into *\*pobj*.
56+
Get a :term:`strong reference` to the referenced object from a weak
57+
reference, *ref*, into *\*pobj*.
5758
Return 0 on success. Raise an exception and return -1 on error.
5859
5960
If the referent is no longer live, set *\*pobj* to ``NULL`` and return 0.
@@ -63,8 +64,8 @@ as much as it can.
6364
6465
.. c:function:: PyObject* PyWeakref_GetObject(PyObject *ref)
6566
66-
Return the referenced object from a weak reference, *ref*. If the referent is
67-
no longer live, returns :const:`Py_None`.
67+
Return a :term:`borrowed reference` to the referenced object from a weak
68+
reference, *ref*. If the referent is no longer live, returns ``Py_None``.
6869
6970
.. note::
7071

0 commit comments

Comments
 (0)