Kaydet (Commit) 4ed35fc4 authored tarafından Martin Panter's avatar Martin Panter

Issue #25161: Add full stops in documentation; patch by Takase Arihiro

üst dab305ef
...@@ -29,7 +29,7 @@ bound into a function. ...@@ -29,7 +29,7 @@ bound into a function.
.. c:function:: int PyCode_Check(PyObject *co) .. 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(PyObject *co) .. c:function:: int PyCode_GetNumFree(PyObject *co)
......
...@@ -17,7 +17,7 @@ than explicitly calling :c:func:`PyGen_New`. ...@@ -17,7 +17,7 @@ than explicitly calling :c:func:`PyGen_New`.
.. c:var:: PyTypeObject PyGen_Type .. 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) .. c:function:: int PyGen_Check(ob)
......
...@@ -168,7 +168,7 @@ the same library that the Python runtime is using. ...@@ -168,7 +168,7 @@ the same library that the Python runtime is using.
.. c:function:: struct _node* PyParser_SimpleParseFile(FILE *fp, const char *filename, int start) .. c:function:: struct _node* PyParser_SimpleParseFile(FILE *fp, const char *filename, int start)
This is a simplified interface to :c:func:`PyParser_SimpleParseFileFlags` below, 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) .. c:function:: struct _node* PyParser_SimpleParseFileFlags(FILE *fp, const char *filename, int start, int flags)
......
...@@ -926,7 +926,7 @@ timestamp dependency analysis. ...@@ -926,7 +926,7 @@ timestamp dependency analysis.
Walk two filename lists in parallel, testing if each source is newer than its Walk two filename lists in parallel, testing if each source is newer than its
corresponding target. Return a pair of lists (*sources*, *targets*) where 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... .. % % equivalent to a listcomp...
......
...@@ -271,7 +271,7 @@ and off individually. They are described here in more detail. ...@@ -271,7 +271,7 @@ and off individually. They are described here in more detail.
.. 2to3fixer:: input .. 2to3fixer:: input
Converts ``input(prompt)`` to ``eval(input(prompt))`` Converts ``input(prompt)`` to ``eval(input(prompt))``.
.. 2to3fixer:: intern .. 2to3fixer:: intern
......
...@@ -1948,4 +1948,4 @@ A partial upgrade path from :mod:`optparse` to :mod:`argparse`: ...@@ -1948,4 +1948,4 @@ A partial upgrade path from :mod:`optparse` to :mod:`argparse`:
``%(default)s`` and ``%(prog)s``. ``%(default)s`` and ``%(prog)s``.
* Replace the OptionParser constructor ``version`` argument with a call to * Replace the OptionParser constructor ``version`` argument with a call to
``parser.add_argument('--version', action='version', version='<the version>')`` ``parser.add_argument('--version', action='version', version='<the version>')``.
...@@ -223,7 +223,7 @@ The :mod:`bdb` module also defines two classes: ...@@ -223,7 +223,7 @@ The :mod:`bdb` module also defines two classes:
.. method:: set_until(frame) .. method:: set_until(frame)
Stop when the line with the line no greater than the current one is 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]) .. method:: set_trace([frame])
......
...@@ -116,7 +116,7 @@ Cookie Objects ...@@ -116,7 +116,7 @@ Cookie Objects
Return an encoded value. *val* can be any type, but return value must be a 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 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 In general, it should be the case that :meth:`value_encode` and
:meth:`value_decode` are inverses on the range of *value_decode*. :meth:`value_decode` are inverses on the range of *value_decode*.
......
...@@ -546,7 +546,7 @@ Netscape protocol strictness switches: ...@@ -546,7 +546,7 @@ Netscape protocol strictness switches:
.. attribute:: DefaultCookiePolicy.strict_ns_unverifiable .. 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 .. attribute:: DefaultCookiePolicy.strict_ns_domain
......
...@@ -890,7 +890,7 @@ Decimal objects ...@@ -890,7 +890,7 @@ Decimal objects
Engineering notation has an exponent which is a multiple of 3, so there 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 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[, context]]) .. method:: to_integral([rounding[, context]])
......
...@@ -496,7 +496,7 @@ module for more information. ...@@ -496,7 +496,7 @@ module for more information.
.. exception:: SyntaxWarning .. exception:: SyntaxWarning
Base class for warnings about dubious syntax Base class for warnings about dubious syntax.
.. exception:: RuntimeWarning .. exception:: RuntimeWarning
......
...@@ -89,7 +89,7 @@ another rational number, or from a string. ...@@ -89,7 +89,7 @@ another rational number, or from a string.
This class method constructs a :class:`Fraction` representing the exact This class method constructs a :class:`Fraction` representing the exact
value of *flt*, which must be a :class:`float`. Beware that 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:: From Python 2.7 onwards, you can also construct a .. note:: From Python 2.7 onwards, you can also construct a
:class:`Fraction` instance directly from a :class:`float`. :class:`Fraction` instance directly from a :class:`float`.
......
...@@ -356,7 +356,7 @@ Encoders and Decoders ...@@ -356,7 +356,7 @@ Encoders and Decoders
.. method:: decode(s) .. method:: decode(s)
Return the Python representation of *s* (a :class:`str` or Return the Python representation of *s* (a :class:`str` or
:class:`unicode` instance containing a JSON document) :class:`unicode` instance containing a JSON document).
.. method:: raw_decode(s) .. method:: raw_decode(s)
......
...@@ -208,7 +208,7 @@ The :mod:`locale` module defines the following exception and functions: ...@@ -208,7 +208,7 @@ The :mod:`locale` module defines the following exception and functions:
.. data:: RADIXCHAR .. data:: RADIXCHAR
Get the radix character (decimal dot, decimal comma, etc.) Get the radix character (decimal dot, decimal comma, etc.).
.. data:: THOUSEP .. data:: THOUSEP
......
...@@ -55,7 +55,7 @@ report of the imported modules will be printed. ...@@ -55,7 +55,7 @@ report of the imported modules will be printed.
.. attribute:: modules .. attribute:: modules
A dictionary mapping module names to modules. See A dictionary mapping module names to modules. See
:ref:`modulefinder-example` :ref:`modulefinder-example`.
.. _modulefinder-example: .. _modulefinder-example:
......
...@@ -19,7 +19,7 @@ documentation. ...@@ -19,7 +19,7 @@ documentation.
The module implements both the normal and wide char variants of the console I/O 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 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 for internationalized applications. The wide char API should be used where
ever possible ever possible.
.. _msvcrt-files: .. _msvcrt-files:
......
...@@ -1705,7 +1705,7 @@ itself. This means, for example, that one shared object can contain a second: ...@@ -1705,7 +1705,7 @@ itself. This means, for example, that one shared object can contain a second:
raised by :meth:`_callmethod`. raised by :meth:`_callmethod`.
Note in particular that an exception will be raised if *methodname* has 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`: An example of the usage of :meth:`_callmethod`:
......
...@@ -126,7 +126,7 @@ Cross Platform ...@@ -126,7 +126,7 @@ Cross Platform
.. function:: python_version() .. 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 Note that unlike the Python ``sys.version``, the returned value will always
include the patchlevel (it defaults to 0). include the patchlevel (it defaults to 0).
......
...@@ -291,7 +291,7 @@ provided. They rely on the :mod:`zipfile` and :mod:`tarfile` modules. ...@@ -291,7 +291,7 @@ provided. They rely on the :mod:`zipfile` and :mod:`tarfile` modules.
.. function:: get_archive_formats() .. function:: get_archive_formats()
Return a list of supported formats for archiving. 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: By default :mod:`shutil` provides these formats:
......
...@@ -479,7 +479,7 @@ input, output, and error streams. ...@@ -479,7 +479,7 @@ input, output, and error streams.
Similar to :class:`BaseCGIHandler`, but designed for use with HTTP origin Similar to :class:`BaseCGIHandler`, but designed for use with HTTP origin
servers. If you are writing an HTTP server implementation, you will probably 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 This class is a subclass of :class:`BaseHandler`. It overrides the
:meth:`__init__`, :meth:`get_stdin`, :meth:`get_stderr`, :meth:`add_cgi_vars`, :meth:`__init__`, :meth:`get_stdin`, :meth:`get_stderr`, :meth:`add_cgi_vars`,
......
...@@ -18,7 +18,7 @@ ...@@ -18,7 +18,7 @@
Model interface, with an API similar to that in other languages. It is intended 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 to be simpler than the full DOM and also significantly smaller. Users who are
not already proficient with the DOM should consider using the 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:: .. warning::
......
...@@ -321,7 +321,7 @@ All of the components of an XML document are subclasses of :class:`Node`. ...@@ -321,7 +321,7 @@ All of the components of an XML document are subclasses of :class:`Node`.
.. attribute:: Node.prefix .. attribute:: Node.prefix
The part of the :attr:`tagName` preceding the colon if there is one, else the 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 .. attribute:: Node.namespaceURI
......
...@@ -829,7 +829,7 @@ ElementTree Objects ...@@ -829,7 +829,7 @@ ElementTree Objects
Creates and returns a tree iterator for the root element. The iterator 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 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) .. method:: iterfind(match)
......
...@@ -1341,6 +1341,7 @@ John Szakmeister ...@@ -1341,6 +1341,7 @@ John Szakmeister
Amir Szekely Amir Szekely
Arfrever Frehtes Taifersar Arahesis Arfrever Frehtes Taifersar Arahesis
Hideaki Takahashi Hideaki Takahashi
Takase Arihiro
Indra Talip Indra Talip
Neil Tallim Neil Tallim
Geoff Talvola Geoff Talvola
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment