mirror of
https://github.com/python/cpython.git
synced 2025-09-29 19:56:59 +00:00
Extending Python Doc minor updates (GH-4518) (GH-4535)
Move footnote markers to be closer to the related terminology:
before the end of the sentence, instead of after.
(cherry picked from commit cdfe910e74
)
This commit is contained in:
parent
ff847d1ac7
commit
90abbee7aa
2 changed files with 4 additions and 4 deletions
|
@ -40,7 +40,7 @@ A Simple Example
|
||||||
|
|
||||||
Let's create an extension module called ``spam`` (the favorite food of Monty
|
Let's create an extension module called ``spam`` (the favorite food of Monty
|
||||||
Python fans...) and let's say we want to create a Python interface to the C
|
Python fans...) and let's say we want to create a Python interface to the C
|
||||||
library function :c:func:`system`. [#]_ This function takes a null-terminated
|
library function :c:func:`system` [#]_. This function takes a null-terminated
|
||||||
character string as argument and returns an integer. We want this function to
|
character string as argument and returns an integer. We want this function to
|
||||||
be callable from Python as follows::
|
be callable from Python as follows::
|
||||||
|
|
||||||
|
@ -917,7 +917,7 @@ It is also possible to :dfn:`borrow` [#]_ a reference to an object. The
|
||||||
borrower of a reference should not call :c:func:`Py_DECREF`. The borrower must
|
borrower of a reference should not call :c:func:`Py_DECREF`. The borrower must
|
||||||
not hold on to the object longer than the owner from which it was borrowed.
|
not hold on to the object longer than the owner from which it was borrowed.
|
||||||
Using a borrowed reference after the owner has disposed of it risks using freed
|
Using a borrowed reference after the owner has disposed of it risks using freed
|
||||||
memory and should be avoided completely. [#]_
|
memory and should be avoided completely [#]_.
|
||||||
|
|
||||||
The advantage of borrowing over owning a reference is that you don't need to
|
The advantage of borrowing over owning a reference is that you don't need to
|
||||||
take care of disposing of the reference on all possible paths through the code
|
take care of disposing of the reference on all possible paths through the code
|
||||||
|
@ -1088,7 +1088,7 @@ checking.
|
||||||
|
|
||||||
The C function calling mechanism guarantees that the argument list passed to C
|
The C function calling mechanism guarantees that the argument list passed to C
|
||||||
functions (``args`` in the examples) is never *NULL* --- in fact it guarantees
|
functions (``args`` in the examples) is never *NULL* --- in fact it guarantees
|
||||||
that it is always a tuple. [#]_
|
that it is always a tuple [#]_.
|
||||||
|
|
||||||
It is a severe error to ever let a *NULL* pointer "escape" to the Python user.
|
It is a severe error to ever let a *NULL* pointer "escape" to the Python user.
|
||||||
|
|
||||||
|
|
|
@ -666,7 +666,7 @@ Fortunately, Python's cyclic-garbage collector will eventually figure out that
|
||||||
the list is garbage and free it.
|
the list is garbage and free it.
|
||||||
|
|
||||||
In the second version of the :class:`Noddy` example, we allowed any kind of
|
In the second version of the :class:`Noddy` example, we allowed any kind of
|
||||||
object to be stored in the :attr:`first` or :attr:`last` attributes. [#]_ This
|
object to be stored in the :attr:`first` or :attr:`last` attributes [#]_. This
|
||||||
means that :class:`Noddy` objects can participate in cycles::
|
means that :class:`Noddy` objects can participate in cycles::
|
||||||
|
|
||||||
>>> import noddy2
|
>>> import noddy2
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue