[Python-checkins] Extending Python Doc minor updates (GH-4518)

Mariatta webhook-mailer at python.org
Fri Nov 24 03:50:00 EST 2017


https://github.com/python/cpython/commit/cdfe910e746e1d0fc43429b8cc3384a65a19b358
commit: cdfe910e746e1d0fc43429b8cc3384a65a19b358
branch: master
author: Emanuele Gaifas <lelegaifax at gmail.com>
committer: Mariatta <Mariatta at users.noreply.github.com>
date: 2017-11-24T00:49:57-08:00
summary:

Extending Python Doc minor updates  (GH-4518)

Move footnote markers to be closer to the related terminology:
before the end of the sentence, instead of after.

files:
M Doc/extending/extending.rst
M Doc/extending/newtypes.rst

diff --git a/Doc/extending/extending.rst b/Doc/extending/extending.rst
index 7c273533aba..ea1c29a397e 100644
--- a/Doc/extending/extending.rst
+++ b/Doc/extending/extending.rst
@@ -40,7 +40,7 @@ A Simple Example
 
 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
-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
 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
 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
-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
 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
 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.
 
diff --git a/Doc/extending/newtypes.rst b/Doc/extending/newtypes.rst
index 0e36ba0aec0..62fbdb87a53 100644
--- a/Doc/extending/newtypes.rst
+++ b/Doc/extending/newtypes.rst
@@ -659,7 +659,7 @@ Fortunately, Python's cyclic-garbage collector will eventually figure out that
 the list is garbage and free it.
 
 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::
 
    >>> import noddy2



More information about the Python-checkins mailing list