Skip to content

Commit

Permalink
pythongh-84436: update docs on Py_None/Py_True/Py_False/Py_Ellipsis b…
Browse files Browse the repository at this point in the history
…ecoming immortal
  • Loading branch information
iritkatriel committed Jun 1, 2023
1 parent c67121a commit 34f3010
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 17 deletions.
21 changes: 11 additions & 10 deletions Doc/c-api/bool.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,29 +19,30 @@ are available, however.
.. c:var:: PyObject* Py_False
The Python ``False`` object. This object has no methods. It needs to be
treated just like any other object with respect to reference counts.
The Python ``False`` object. This object has no methods and is immortal.
.. versionchanged:: 3.12
:const:`Py_False` is immortal.
.. c:var:: PyObject* Py_True
The Python ``True`` object. This object has no methods. It needs to be treated
just like any other object with respect to reference counts.
The Python ``True`` object. This object has no methods and is immortal.
.. versionchanged:: 3.12
:const:`Py_True` is immortal.
.. c:macro:: Py_RETURN_FALSE
Return :const:`Py_False` from a function, properly incrementing its reference
count.
Return :const:`Py_False` from a function.
.. c:macro:: Py_RETURN_TRUE
Return :const:`Py_True` from a function, properly incrementing its reference
count.
Return :const:`Py_True` from a function.
.. c:function:: PyObject* PyBool_FromLong(long v)
Return a new reference to :const:`Py_True` or :const:`Py_False` depending on the
truth value of *v*.
Return :const:`Py_True` or :const:`Py_False`, depending on the truth value of *v*.
7 changes: 3 additions & 4 deletions Doc/c-api/none.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,10 @@ same reason.
.. c:var:: PyObject* Py_None
The Python ``None`` object, denoting lack of value. This object has no methods.
It needs to be treated just like any other object with respect to reference
counts.

.. versionchanged:: 3.12
:const:`Py_None` is immortal.

.. c:macro:: Py_RETURN_NONE
Properly handle returning :c:data:`Py_None` from within a C function (that is,
increment the reference count of ``None`` and return it.)
Return :c:data:`Py_None` from a function.
8 changes: 5 additions & 3 deletions Doc/c-api/slice.rst
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,8 @@ Ellipsis Object
.. c:var:: PyObject *Py_Ellipsis
The Python ``Ellipsis`` object. This object has no methods. It needs to be
treated just like any other object with respect to reference counts. Like
:c:data:`Py_None` it is a singleton object.
The Python ``Ellipsis`` object. This object has no methods. Like
:c:data:`Py_None` it is an immortal singleton object.
.. versionchanged:: 3.12
:const:`Py_Ellipsis` is immortal.

0 comments on commit 34f3010

Please sign in to comment.