traverseda
/
cpython
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

bpo-42294: Grammar fixes in doc glossary strong/weak refs (GH-23227)

This commit is contained in:
kj 2020-11-11 07:56:55 +08:00 committed by GitHub
parent 7e5ef0a571
commit 78ba7c69ad
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Doc/c-api/weakref.rst
View File

@ -59,7 +59,7 @@ as much as it can.
This function returns a :term:`borrowed reference` to the referenced object. This function returns a :term:`borrowed reference` to the referenced object.
This means that you should always call :c:func:`Py_INCREF` on the object This means that you should always call :c:func:`Py_INCREF` on the object
except it cannot be destroyed before the last usage of the borrowed except when it cannot be destroyed before the last usage of the borrowed
reference. reference.

10
Doc/glossary.rst
View File

@ -159,14 +159,14 @@ Glossary
:class:`str` objects. :class:`str` objects.
borrowed reference borrowed reference
In the Python's C API, a borrowed reference is a reference to an object. In Python's C API, a borrowed reference is a reference to an object.
It does not modify the object reference count. It becomes a dangling It does not modify the object reference count. It becomes a dangling
pointer if the object is destroyed. For example, a garbage collection can pointer if the object is destroyed. For example, a garbage collection can
remove the last :term:`strong reference` to the object and so destroy it. remove the last :term:`strong reference` to the object and so destroy it.
Calling :c:func:`Py_INCREF` on the :term:`borrowed reference` is Calling :c:func:`Py_INCREF` on the :term:`borrowed reference` is
recommended to convert it to a :term:`strong reference` in-place, except recommended to convert it to a :term:`strong reference` in-place, except
if the object cannot be destroyed before the last usage of the borrowed when the object cannot be destroyed before the last usage of the borrowed
reference. The :c:func:`Py_NewRef` function can be used to create a new reference. The :c:func:`Py_NewRef` function can be used to create a new
:term:`strong reference`. :term:`strong reference`.
@ -1113,9 +1113,9 @@ Glossary
as :keyword:`if`, :keyword:`while` or :keyword:`for`. as :keyword:`if`, :keyword:`while` or :keyword:`for`.
strong reference strong reference
In the Python's C API, a strong reference is a reference to an object In Python's C API, a strong reference is a reference to an object
which increments object reference count when it is created and which increments the object's reference count when it is created and
decrements the object reference count when it is deleted. decrements the object's reference count when it is deleted.
The :c:func:`Py_NewRef` function can be used to create a strong reference The :c:func:`Py_NewRef` function can be used to create a strong reference
to an object. Usually, the :c:func:`Py_DECREF` function must be called on to an object. Usually, the :c:func:`Py_DECREF` function must be called on