From d21e0b52f1421e253ecdc583faf5743133cac605 Mon Sep 17 00:00:00 2001 From: Martin Panter Date: Sat, 10 Oct 2015 10:36:22 +0000 Subject: [PATCH] Issue #25161: Add full stops in documentation; patch by Takase Arihiro --- Doc/c-api/code.rst | 2 +- Doc/c-api/gen.rst | 2 +- Doc/c-api/veryhigh.rst | 2 +- Doc/distutils/apiref.rst | 2 +- Doc/glossary.rst | 2 +- Doc/library/2to3.rst | 2 +- Doc/library/argparse.rst | 2 +- Doc/library/asyncio-protocol.rst | 2 +- Doc/library/bdb.rst | 2 +- Doc/library/contextlib.rst | 2 +- Doc/library/decimal.rst | 2 +- Doc/library/email.charset.rst | 2 +- Doc/library/enum.rst | 2 +- Doc/library/exceptions.rst | 2 +- Doc/library/fractions.rst | 2 +- Doc/library/http.cookiejar.rst | 2 +- Doc/library/http.cookies.rst | 2 +- Doc/library/importlib.rst | 2 +- Doc/library/json.rst | 2 +- Doc/library/locale.rst | 2 +- Doc/library/logging.handlers.rst | 2 +- Doc/library/modulefinder.rst | 2 +- Doc/library/msvcrt.rst | 2 +- Doc/library/multiprocessing.rst | 6 +++--- Doc/library/pickle.rst | 2 +- Doc/library/platform.rst | 2 +- Doc/library/plistlib.rst | 2 +- Doc/library/shutil.rst | 2 +- Doc/library/sys.rst | 2 +- Doc/library/tkinter.ttk.rst | 5 +++-- Doc/library/urllib.request.rst | 2 +- Doc/library/wsgiref.rst | 2 +- Doc/library/xml.dom.minidom.rst | 2 +- Doc/library/xml.dom.rst | 2 +- Doc/library/xml.etree.elementtree.rst | 2 +- Doc/reference/datamodel.rst | 2 +- Doc/reference/expressions.rst | 2 +- Misc/ACKS | 1 + 38 files changed, 42 insertions(+), 40 deletions(-) diff --git a/Doc/c-api/code.rst b/Doc/c-api/code.rst index 57e8072d99c..9c935633824 100644 --- a/Doc/c-api/code.rst +++ b/Doc/c-api/code.rst @@ -29,7 +29,7 @@ bound into a function. .. c:function:: int PyCode_Check(PyObject *co) - Return true if *co* is a :class:`code` object + Return true if *co* is a :class:`code` object. .. c:function:: int PyCode_GetNumFree(PyCodeObject *co) diff --git a/Doc/c-api/gen.rst b/Doc/c-api/gen.rst index 33cd27a5aa6..0c851a75efb 100644 --- a/Doc/c-api/gen.rst +++ b/Doc/c-api/gen.rst @@ -17,7 +17,7 @@ than explicitly calling :c:func:`PyGen_New`. .. c:var:: PyTypeObject PyGen_Type - The type object corresponding to generator objects + The type object corresponding to generator objects. .. c:function:: int PyGen_Check(ob) diff --git a/Doc/c-api/veryhigh.rst b/Doc/c-api/veryhigh.rst index f7ed4c77139..f8aaf0f67ad 100644 --- a/Doc/c-api/veryhigh.rst +++ b/Doc/c-api/veryhigh.rst @@ -201,7 +201,7 @@ the same library that the Python runtime is using. .. c:function:: struct _node* PyParser_SimpleParseFile(FILE *fp, const char *filename, int start) This is a simplified interface to :c:func:`PyParser_SimpleParseFileFlags` below, - leaving *flags* set to ``0`` + leaving *flags* set to ``0``. .. c:function:: struct _node* PyParser_SimpleParseFileFlags(FILE *fp, const char *filename, int start, int flags) diff --git a/Doc/distutils/apiref.rst b/Doc/distutils/apiref.rst index 6eb87cb2f79..f67fc5ae251 100644 --- a/Doc/distutils/apiref.rst +++ b/Doc/distutils/apiref.rst @@ -920,7 +920,7 @@ timestamp dependency analysis. Walk two filename lists in parallel, testing if each source is newer than its corresponding target. Return a pair of lists (*sources*, *targets*) where - source is newer than target, according to the semantics of :func:`newer` + source is newer than target, according to the semantics of :func:`newer`. .. % % equivalent to a listcomp... diff --git a/Doc/glossary.rst b/Doc/glossary.rst index c8af5f30907..36832a33d48 100644 --- a/Doc/glossary.rst +++ b/Doc/glossary.rst @@ -867,7 +867,7 @@ Glossary without interfering with the behaviour of other Python applications running on the same system. - See also :ref:`scripts-pyvenv` + See also :ref:`scripts-pyvenv`. virtual machine A computer defined entirely in software. Python's virtual machine diff --git a/Doc/library/2to3.rst b/Doc/library/2to3.rst index 6473861883f..31f681d7e09 100644 --- a/Doc/library/2to3.rst +++ b/Doc/library/2to3.rst @@ -271,7 +271,7 @@ and off individually. They are described here in more detail. .. 2to3fixer:: input - Converts ``input(prompt)`` to ``eval(input(prompt))`` + Converts ``input(prompt)`` to ``eval(input(prompt))``. .. 2to3fixer:: intern diff --git a/Doc/library/argparse.rst b/Doc/library/argparse.rst index 067fb8f7488..d907203a027 100644 --- a/Doc/library/argparse.rst +++ b/Doc/library/argparse.rst @@ -1984,4 +1984,4 @@ A partial upgrade path from :mod:`optparse` to :mod:`argparse`: ``%(default)s`` and ``%(prog)s``. * Replace the OptionParser constructor ``version`` argument with a call to - ``parser.add_argument('--version', action='version', version='')`` + ``parser.add_argument('--version', action='version', version='')``. diff --git a/Doc/library/asyncio-protocol.rst b/Doc/library/asyncio-protocol.rst index 656816f75b0..698d2bfa1a9 100644 --- a/Doc/library/asyncio-protocol.rst +++ b/Doc/library/asyncio-protocol.rst @@ -232,7 +232,7 @@ BaseSubprocessTransport .. method:: kill(self) - Kill the subprocess, as in :meth:`subprocess.Popen.kill` + Kill the subprocess, as in :meth:`subprocess.Popen.kill`. On POSIX systems, the function sends SIGKILL to the subprocess. On Windows, this method is an alias for :meth:`terminate`. diff --git a/Doc/library/bdb.rst b/Doc/library/bdb.rst index 7229087b5db..8ee9921553b 100644 --- a/Doc/library/bdb.rst +++ b/Doc/library/bdb.rst @@ -231,7 +231,7 @@ The :mod:`bdb` module also defines two classes: .. method:: set_until(frame) Stop when the line with the line no greater than the current one is - reached or when returning from current frame + reached or when returning from current frame. .. method:: set_trace([frame]) diff --git a/Doc/library/contextlib.rst b/Doc/library/contextlib.rst index 6f36864ac24..e5675493db3 100644 --- a/Doc/library/contextlib.rst +++ b/Doc/library/contextlib.rst @@ -543,7 +543,7 @@ advance:: Due to the way the decorator protocol works, a callback function declared this way cannot take any parameters. Instead, any resources to -be released must be accessed as closure variables +be released must be accessed as closure variables. Using a context manager as a function decorator diff --git a/Doc/library/decimal.rst b/Doc/library/decimal.rst index 759be70c9fb..ca41c3a824e 100644 --- a/Doc/library/decimal.rst +++ b/Doc/library/decimal.rst @@ -845,7 +845,7 @@ Decimal objects Engineering notation has an exponent which is a multiple of 3, so there are up to 3 digits left of the decimal place. For example, converts - ``Decimal('123E+1')`` to ``Decimal('1.23E+3')`` + ``Decimal('123E+1')`` to ``Decimal('1.23E+3')``. .. method:: to_integral(rounding=None, context=None) diff --git a/Doc/library/email.charset.rst b/Doc/library/email.charset.rst index 19a69532eda..80ef3d62ccc 100644 --- a/Doc/library/email.charset.rst +++ b/Doc/library/email.charset.rst @@ -234,5 +234,5 @@ new entries to the global character set, alias, and codec registries: *charset* is the canonical name of a character set. *codecname* is the name of a Python codec, as appropriate for the second argument to the :class:`str`'s - :meth:`~str.encode` method + :meth:`~str.encode` method. diff --git a/Doc/library/enum.rst b/Doc/library/enum.rst index cf095592f6b..1c76e8728d1 100644 --- a/Doc/library/enum.rst +++ b/Doc/library/enum.rst @@ -708,7 +708,7 @@ allow one to do things with an :class:`Enum` class that fail on a typical class, such as `list(Color)` or `some_var in Color`. :class:`EnumMeta` is responsible for ensuring that various other methods on the final :class:`Enum` class are correct (such as :meth:`__new__`, :meth:`__getnewargs__`, -:meth:`__str__` and :meth:`__repr__`) +:meth:`__str__` and :meth:`__repr__`). Enum Members (aka instances) diff --git a/Doc/library/exceptions.rst b/Doc/library/exceptions.rst index 271a5c82194..e9cab386bb7 100644 --- a/Doc/library/exceptions.rst +++ b/Doc/library/exceptions.rst @@ -603,7 +603,7 @@ module for more information. .. exception:: SyntaxWarning - Base class for warnings about dubious syntax + Base class for warnings about dubious syntax. .. exception:: RuntimeWarning diff --git a/Doc/library/fractions.rst b/Doc/library/fractions.rst index c2c74013f04..3d2529d1e5d 100644 --- a/Doc/library/fractions.rst +++ b/Doc/library/fractions.rst @@ -97,7 +97,7 @@ another rational number, or from a string. This class method constructs a :class:`Fraction` representing the exact value of *flt*, which must be a :class:`float`. Beware that - ``Fraction.from_float(0.3)`` is not the same value as ``Fraction(3, 10)`` + ``Fraction.from_float(0.3)`` is not the same value as ``Fraction(3, 10)``. .. note:: diff --git a/Doc/library/http.cookiejar.rst b/Doc/library/http.cookiejar.rst index 1f6b1badf4b..30648acbf0f 100644 --- a/Doc/library/http.cookiejar.rst +++ b/Doc/library/http.cookiejar.rst @@ -540,7 +540,7 @@ Netscape protocol strictness switches: .. attribute:: DefaultCookiePolicy.strict_ns_unverifiable - apply RFC 2965 rules on unverifiable transactions even to Netscape cookies + Apply RFC 2965 rules on unverifiable transactions even to Netscape cookies. .. attribute:: DefaultCookiePolicy.strict_ns_domain diff --git a/Doc/library/http.cookies.rst b/Doc/library/http.cookies.rst index 646f2e88602..d0c1e54dbea 100644 --- a/Doc/library/http.cookies.rst +++ b/Doc/library/http.cookies.rst @@ -84,7 +84,7 @@ Cookie Objects Return an encoded value. *val* can be any type, but return value must be a string. This method does nothing in :class:`BaseCookie` --- it exists so it can - be overridden + be overridden. In general, it should be the case that :meth:`value_encode` and :meth:`value_decode` are inverses on the range of *value_decode*. diff --git a/Doc/library/importlib.rst b/Doc/library/importlib.rst index c84d2dfbb46..42812f67a0b 100644 --- a/Doc/library/importlib.rst +++ b/Doc/library/importlib.rst @@ -717,7 +717,7 @@ find and load modules. modules recognized by the standard import machinery. This is a helper for code which simply needs to know if a filesystem path potentially refers to a module without needing any details on the kind - of module (for example, :func:`inspect.getmodulename`) + of module (for example, :func:`inspect.getmodulename`). .. versionadded:: 3.3 diff --git a/Doc/library/json.rst b/Doc/library/json.rst index 6f5f8b15a8d..a01e6364960 100644 --- a/Doc/library/json.rst +++ b/Doc/library/json.rst @@ -337,7 +337,7 @@ Encoders and Decoders .. method:: decode(s) Return the Python representation of *s* (a :class:`str` instance - containing a JSON document) + containing a JSON document). .. method:: raw_decode(s) diff --git a/Doc/library/locale.rst b/Doc/library/locale.rst index 9600193547e..b14c551b6e0 100644 --- a/Doc/library/locale.rst +++ b/Doc/library/locale.rst @@ -204,7 +204,7 @@ The :mod:`locale` module defines the following exception and functions: .. data:: RADIXCHAR - Get the radix character (decimal dot, decimal comma, etc.) + Get the radix character (decimal dot, decimal comma, etc.). .. data:: THOUSEP diff --git a/Doc/library/logging.handlers.rst b/Doc/library/logging.handlers.rst index d946892eccf..9e558e549db 100644 --- a/Doc/library/logging.handlers.rst +++ b/Doc/library/logging.handlers.rst @@ -230,7 +230,7 @@ need to override. renamed to the destination. :param source: The source filename. This is normally the base - filename, e.g. 'test.log' + filename, e.g. 'test.log'. :param dest: The destination filename. This is normally what the source is rotated to, e.g. 'test.log.1'. diff --git a/Doc/library/modulefinder.rst b/Doc/library/modulefinder.rst index 0656b37de1a..e84a4964a07 100644 --- a/Doc/library/modulefinder.rst +++ b/Doc/library/modulefinder.rst @@ -53,7 +53,7 @@ report of the imported modules will be printed. .. attribute:: modules A dictionary mapping module names to modules. See - :ref:`modulefinder-example` + :ref:`modulefinder-example`. .. _modulefinder-example: diff --git a/Doc/library/msvcrt.rst b/Doc/library/msvcrt.rst index 9d23720e322..fadaf05a09f 100644 --- a/Doc/library/msvcrt.rst +++ b/Doc/library/msvcrt.rst @@ -18,7 +18,7 @@ documentation. The module implements both the normal and wide char variants of the console I/O api. The normal API deals only with ASCII characters and is of limited use for internationalized applications. The wide char API should be used where -ever possible +ever possible. .. versionchanged:: 3.3 Operations in this module now raise :exc:`OSError` where :exc:`IOError` diff --git a/Doc/library/multiprocessing.rst b/Doc/library/multiprocessing.rst index 82de19b5c86..3ffb7f9fd38 100644 --- a/Doc/library/multiprocessing.rst +++ b/Doc/library/multiprocessing.rst @@ -1936,7 +1936,7 @@ itself. This means, for example, that one shared object can contain a second: raised by :meth:`_callmethod`. Note in particular that an exception will be raised if *methodname* has - not been *exposed* + not been *exposed*. An example of the usage of :meth:`_callmethod`: @@ -2042,7 +2042,7 @@ with the :class:`Pool` class. If *callback* is specified then it should be a callable which accepts a single argument. When the result becomes ready *callback* is applied to it, that is unless the call failed, in which case the *error_callback* - is applied instead + is applied instead. If *error_callback* is specified then it should be a callable which accepts a single argument. If the target function fails, then @@ -2067,7 +2067,7 @@ with the :class:`Pool` class. If *callback* is specified then it should be a callable which accepts a single argument. When the result becomes ready *callback* is applied to it, that is unless the call failed, in which case the *error_callback* - is applied instead + is applied instead. If *error_callback* is specified then it should be a callable which accepts a single argument. If the target function fails, then diff --git a/Doc/library/pickle.rst b/Doc/library/pickle.rst index 0f48cb188f9..25a92403008 100644 --- a/Doc/library/pickle.rst +++ b/Doc/library/pickle.rst @@ -235,7 +235,7 @@ process more convenient: .. function:: loads(bytes_object, \*, fix_imports=True, encoding="ASCII", errors="strict") Read a pickled object hierarchy from a :class:`bytes` object and return the - reconstituted object hierarchy specified therein + reconstituted object hierarchy specified therein. The protocol version of the pickle is detected automatically, so no protocol argument is needed. Bytes past the pickled object's diff --git a/Doc/library/platform.rst b/Doc/library/platform.rst index e27f2ad8b0e..66b6892f176 100644 --- a/Doc/library/platform.rst +++ b/Doc/library/platform.rst @@ -117,7 +117,7 @@ Cross Platform .. function:: python_version() - Returns the Python version as string ``'major.minor.patchlevel'`` + Returns the Python version as string ``'major.minor.patchlevel'``. Note that unlike the Python ``sys.version``, the returned value will always include the patchlevel (it defaults to 0). diff --git a/Doc/library/plistlib.rst b/Doc/library/plistlib.rst index 416559114b2..2c1f3dd79e1 100644 --- a/Doc/library/plistlib.rst +++ b/Doc/library/plistlib.rst @@ -194,7 +194,7 @@ The following classes are available: It has one attribute, :attr:`data`, that can be used to retrieve the Python bytes object stored in it. - .. deprecated:: 3.4 Use a :class:`bytes` object instead + .. deprecated:: 3.4 Use a :class:`bytes` object instead. The following constants are available: diff --git a/Doc/library/shutil.rst b/Doc/library/shutil.rst index 04afe928c8d..2606feddf45 100644 --- a/Doc/library/shutil.rst +++ b/Doc/library/shutil.rst @@ -461,7 +461,7 @@ provided. They rely on the :mod:`zipfile` and :mod:`tarfile` modules. .. function:: get_archive_formats() Return a list of supported formats for archiving. - Each element of the returned sequence is a tuple ``(name, description)`` + Each element of the returned sequence is a tuple ``(name, description)``. By default :mod:`shutil` provides these formats: diff --git a/Doc/library/sys.rst b/Doc/library/sys.rst index 3024086a22a..c0378e09b00 100644 --- a/Doc/library/sys.rst +++ b/Doc/library/sys.rst @@ -629,7 +629,7 @@ always available. :term:`struct sequence` :data:`sys.version_info` may be used for a more human-friendly encoding of the same information. - More details of ``hexversion`` can be found at :ref:`apiabiversion` + More details of ``hexversion`` can be found at :ref:`apiabiversion`. .. data:: implementation diff --git a/Doc/library/tkinter.ttk.rst b/Doc/library/tkinter.ttk.rst index ab8a9a99e7d..4601171b596 100644 --- a/Doc/library/tkinter.ttk.rst +++ b/Doc/library/tkinter.ttk.rst @@ -110,8 +110,9 @@ All the :mod:`ttk` Widgets accepts the following options: | class | Specifies the window class. The class is used when querying | | | the option database for the window's other options, to | | | determine the default bindtags for the window, and to select | - | | the widget's default layout and style. This is a read-only | - | | which may only be specified when the window is created | + | | the widget's default layout and style. This option is | + | | read-only, and may only be specified when the window is | + | | created. | +-----------+--------------------------------------------------------------+ | cursor | Specifies the mouse cursor to be used for the widget. If set | | | to the empty string (the default), the cursor is inherited | diff --git a/Doc/library/urllib.request.rst b/Doc/library/urllib.request.rst index 75b95d9b4a7..cd4690faab4 100644 --- a/Doc/library/urllib.request.rst +++ b/Doc/library/urllib.request.rst @@ -201,7 +201,7 @@ The following classes are provided: ``"Python-urllib/2.6"`` (on Python 2.6). An example of using ``Content-Type`` header with *data* argument would be - sending a dictionary like ``{"Content-Type":" application/x-www-form-urlencoded;charset=utf-8"}`` + sending a dictionary like ``{"Content-Type":" application/x-www-form-urlencoded;charset=utf-8"}``. The final two arguments are only of interest for correct handling of third-party HTTP cookies: diff --git a/Doc/library/wsgiref.rst b/Doc/library/wsgiref.rst index a9e19dad982..4ed945417b4 100644 --- a/Doc/library/wsgiref.rst +++ b/Doc/library/wsgiref.rst @@ -501,7 +501,7 @@ input, output, and error streams. Similar to :class:`BaseCGIHandler`, but designed for use with HTTP origin servers. If you are writing an HTTP server implementation, you will probably - want to subclass this instead of :class:`BaseCGIHandler` + want to subclass this instead of :class:`BaseCGIHandler`. This class is a subclass of :class:`BaseHandler`. It overrides the :meth:`__init__`, :meth:`get_stdin`, :meth:`get_stderr`, :meth:`add_cgi_vars`, diff --git a/Doc/library/xml.dom.minidom.rst b/Doc/library/xml.dom.minidom.rst index ff5c270d9f6..dcd030cc122 100644 --- a/Doc/library/xml.dom.minidom.rst +++ b/Doc/library/xml.dom.minidom.rst @@ -15,7 +15,7 @@ Model interface, with an API similar to that in other languages. It is intended to be simpler than the full DOM and also significantly smaller. Users who are not already proficient with the DOM should consider using the -:mod:`xml.etree.ElementTree` module for their XML processing instead +:mod:`xml.etree.ElementTree` module for their XML processing instead. .. warning:: diff --git a/Doc/library/xml.dom.rst b/Doc/library/xml.dom.rst index 4914738dfc6..a432202ec0e 100644 --- a/Doc/library/xml.dom.rst +++ b/Doc/library/xml.dom.rst @@ -304,7 +304,7 @@ All of the components of an XML document are subclasses of :class:`Node`. .. attribute:: Node.prefix The part of the :attr:`tagName` preceding the colon if there is one, else the - empty string. The value is a string, or ``None`` + empty string. The value is a string, or ``None``. .. attribute:: Node.namespaceURI diff --git a/Doc/library/xml.etree.elementtree.rst b/Doc/library/xml.etree.elementtree.rst index 14e5c9932f8..dc0274eb0bf 100644 --- a/Doc/library/xml.etree.elementtree.rst +++ b/Doc/library/xml.etree.elementtree.rst @@ -891,7 +891,7 @@ ElementTree Objects Creates and returns a tree iterator for the root element. The iterator loops over all elements in this tree, in section order. *tag* is the tag - to look for (default is to return all elements) + to look for (default is to return all elements). .. method:: iterfind(match, namespaces=None) diff --git a/Doc/reference/datamodel.rst b/Doc/reference/datamodel.rst index 4acf13e97bc..4e84d5e58ea 100644 --- a/Doc/reference/datamodel.rst +++ b/Doc/reference/datamodel.rst @@ -1310,7 +1310,7 @@ Basic customization object's :meth:`__hash__` must interoperate on builds of different bit sizes, be sure to check the width on all supported builds. An easy way to do this is with - ``python -c "import sys; print(sys.hash_info.width)"`` + ``python -c "import sys; print(sys.hash_info.width)"``. If a class does not define an :meth:`__eq__` method it should not define a :meth:`__hash__` operation either; if it defines :meth:`__eq__` but not diff --git a/Doc/reference/expressions.rst b/Doc/reference/expressions.rst index 29ef0b77664..b6b2b006fa1 100644 --- a/Doc/reference/expressions.rst +++ b/Doc/reference/expressions.rst @@ -371,7 +371,7 @@ the yield expression. It can be either set explicitly when raising (by returning a value from the sub-generator). .. versionchanged:: 3.3 - Added ``yield from `` to delegate control flow to a subiterator + Added ``yield from `` to delegate control flow to a subiterator. The parentheses may be omitted when the yield expression is the sole expression on the right hand side of an assignment statement. diff --git a/Misc/ACKS b/Misc/ACKS index b9b3e7bb7c7..d0ba52f1937 100644 --- a/Misc/ACKS +++ b/Misc/ACKS @@ -1367,6 +1367,7 @@ John Szakmeister Amir Szekely Arfrever Frehtes Taifersar Arahesis Hideaki Takahashi +Takase Arihiro Indra Talip Neil Tallim Geoff Talvola