Commit 916bd38a authored by Senthil Kumaran's avatar Senthil Kumaran

Fixing some sphinx inline directives - detected using ``make check``.

parent 8dbf629b
...@@ -16,9 +16,9 @@ installed Python and Subversion, you can just run :: ...@@ -16,9 +16,9 @@ installed Python and Subversion, you can just run ::
make html make html
to check out the necessary toolset in the `tools/` subdirectory and build the to check out the necessary toolset in the :file:`tools/` subdirectory and build
HTML output files. To view the generated HTML, point your favorite browser at the HTML output files. To view the generated HTML, point your favorite browser
the top-level index `build/html/index.html` after running "make". at the top-level index :file:`build/html/index.html` after running "make".
Available make targets are: Available make targets are:
...@@ -49,10 +49,10 @@ Available make targets are: ...@@ -49,10 +49,10 @@ Available make targets are:
* "pydoc-topics", which builds a Python module containing a dictionary with * "pydoc-topics", which builds a Python module containing a dictionary with
plain text documentation for the labels defined in plain text documentation for the labels defined in
`tools/sphinxext/pyspecific.py` -- pydoc needs these to show topic and :file:`tools/sphinxext/pyspecific.py` -- pydoc needs these to show topic and
keyword help. keyword help.
A "make update" updates the Subversion checkouts in `tools/`. A "make update" updates the Subversion checkouts in :file:`tools/`.
Without make Without make
......
...@@ -283,12 +283,12 @@ The :class:`Future` class encapsulates the asynchronous execution of a callable. ...@@ -283,12 +283,12 @@ The :class:`Future` class encapsulates the asynchronous execution of a callable.
before executing the work associated with the :class:`Future` and by unit before executing the work associated with the :class:`Future` and by unit
tests. tests.
If the method returns `False` then the :class:`Future` was cancelled, If the method returns ``False`` then the :class:`Future` was cancelled,
i.e. :meth:`Future.cancel` was called and returned `True`. Any threads i.e. :meth:`Future.cancel` was called and returned `True`. Any threads
waiting on the :class:`Future` completing (i.e. through waiting on the :class:`Future` completing (i.e. through
:func:`as_completed` or :func:`wait`) will be woken up. :func:`as_completed` or :func:`wait`) will be woken up.
If the method returns `True` then the :class:`Future` was not cancelled If the method returns ``True`` then the :class:`Future` was not cancelled
and has been put in the running state, i.e. calls to and has been put in the running state, i.e. calls to
:meth:`Future.running` will return `True`. :meth:`Future.running` will return `True`.
......
...@@ -99,7 +99,7 @@ formatted string representation of a message object. For more detail, see ...@@ -99,7 +99,7 @@ formatted string representation of a message object. For more detail, see
This class has the same API as the :class:`Generator` class, except that This class has the same API as the :class:`Generator` class, except that
*outfp* must be a file like object that will accept :class`bytes` input to *outfp* must be a file like object that will accept :class`bytes` input to
its `write` method. If the message object structure contains non-ASCII its ``write`` method. If the message object structure contains non-ASCII
bytes, this generator's :meth:`~BytesGenerator.flatten` method will produce bytes, this generator's :meth:`~BytesGenerator.flatten` method will produce
them as-is, including preserving parts with a them as-is, including preserving parts with a
:mailheader:`Content-Transfer-Encoding` of ``8bit``. :mailheader:`Content-Transfer-Encoding` of ``8bit``.
......
...@@ -111,8 +111,8 @@ version 5.0: ...@@ -111,8 +111,8 @@ version 5.0:
* Given bytes input to the model, :meth:`~email.message.Message.get_payload` * Given bytes input to the model, :meth:`~email.message.Message.get_payload`
will by default decode a message body that has a will by default decode a message body that has a
:mailheader:`Content-Transfer-Encoding` of `8bit` using the charset specified :mailheader:`Content-Transfer-Encoding` of ``8bit`` using the charset
in the MIME headers and return the resulting string. specified in the MIME headers and return the resulting string.
* Given bytes input to the model, :class:`~email.generator.Generator` will * Given bytes input to the model, :class:`~email.generator.Generator` will
convert message bodies that have a :mailheader:`Content-Transfer-Encoding` of convert message bodies that have a :mailheader:`Content-Transfer-Encoding` of
......
...@@ -21,8 +21,8 @@ structs and the intended conversion to/from Python values. ...@@ -21,8 +21,8 @@ structs and the intended conversion to/from Python values.
alignment is taken into account when unpacking. This behavior is chosen so alignment is taken into account when unpacking. This behavior is chosen so
that the bytes of a packed struct correspond exactly to the layout in memory that the bytes of a packed struct correspond exactly to the layout in memory
of the corresponding C struct. To handle platform-independent data formats of the corresponding C struct. To handle platform-independent data formats
or omit implicit pad bytes, use `standard` size and alignment instead of or omit implicit pad bytes, use ``standard`` size and alignment instead of
`native` size and alignment: see :ref:`struct-alignment` for details. ``native`` size and alignment: see :ref:`struct-alignment` for details.
Functions and Exceptions Functions and Exceptions
------------------------ ------------------------
......
...@@ -382,7 +382,7 @@ Instances of the :class:`Popen` class have the following methods: ...@@ -382,7 +382,7 @@ Instances of the :class:`Popen` class have the following methods:
.. note:: .. note::
On Windows, SIGTERM is an alias for :meth:`terminate`. CTRL_C_EVENT and On Windows, SIGTERM is an alias for :meth:`terminate`. CTRL_C_EVENT and
CTRL_BREAK_EVENT can be sent to processes started with a `creationflags` CTRL_BREAK_EVENT can be sent to processes started with a *creationflags*
parameter which includes `CREATE_NEW_PROCESS_GROUP`. parameter which includes `CREATE_NEW_PROCESS_GROUP`.
......
...@@ -284,9 +284,9 @@ as the start directory. ...@@ -284,9 +284,9 @@ as the start directory.
.. caution:: .. caution::
Test discovery loads tests by importing them. Once test discovery has Test discovery loads tests by importing them. Once test discovery has found
found all the test files from the start directory you specify it turns the all the test files from the start directory you specify it turns the paths
paths into package names to import. For example `foo/bar/baz.py` will be into package names to import. For example :file:`foo/bar/baz.py` will be
imported as ``foo.bar.baz``. imported as ``foo.bar.baz``.
If you have a package installed globally and attempt test discovery on If you have a package installed globally and attempt test discovery on
......
...@@ -28,7 +28,7 @@ The :mod:`urllib.request` module defines the following functions: ...@@ -28,7 +28,7 @@ The :mod:`urllib.request` module defines the following functions:
:mimetype:`application/x-www-form-urlencoded` format. The :mimetype:`application/x-www-form-urlencoded` format. The
:func:`urllib.parse.urlencode` function takes a mapping or sequence :func:`urllib.parse.urlencode` function takes a mapping or sequence
of 2-tuples and returns a string in this format. urllib.request module uses of 2-tuples and returns a string in this format. urllib.request module uses
HTTP/1.1 and includes `Connection:close` header in its HTTP requests. HTTP/1.1 and includes ``Connection:close`` header in its HTTP requests.
The optional *timeout* parameter specifies a timeout in seconds for The optional *timeout* parameter specifies a timeout in seconds for
blocking operations like the connection attempt (if not specified, blocking operations like the connection attempt (if not specified,
......
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