Commit 941afedd authored by Éric Araujo's avatar Éric Araujo

Avoid using the default reST role. Makes Doc/tools/rstlint.py happy.

parent 48e484fd
...@@ -45,8 +45,8 @@ The modern interface provides: ...@@ -45,8 +45,8 @@ The modern interface provides:
at least length 2 (additional characters are ignored) which specifies the at least length 2 (additional characters are ignored) which specifies the
alternative alphabet used instead of the ``+`` and ``/`` characters. alternative alphabet used instead of the ``+`` and ``/`` characters.
The decoded string is returned. A `binascii.Error` is raised if *s* is The decoded string is returned. A :exc:`binascii.Error` exception is raised
incorrectly padded. if *s* is incorrectly padded.
If *validate* is ``False`` (the default), non-base64-alphabet characters are If *validate* is ``False`` (the default), non-base64-alphabet characters are
discarded prior to the padding check. If *validate* is ``True``, discarded prior to the padding check. If *validate* is ``True``,
......
...@@ -806,17 +806,17 @@ To get interpolation, use :class:`ConfigParser`:: ...@@ -806,17 +806,17 @@ To get interpolation, use :class:`ConfigParser`::
cfg = configparser.ConfigParser() cfg = configparser.ConfigParser()
cfg.read('example.cfg') cfg.read('example.cfg')
# Set the optional `raw` argument of get() to True if you wish to disable # Set the optional *raw* argument of get() to True if you wish to disable
# interpolation in a single get operation. # interpolation in a single get operation.
print(cfg.get('Section1', 'foo', raw=False)) # -> "Python is fun!" print(cfg.get('Section1', 'foo', raw=False)) # -> "Python is fun!"
print(cfg.get('Section1', 'foo', raw=True)) # -> "%(bar)s is %(baz)s!" print(cfg.get('Section1', 'foo', raw=True)) # -> "%(bar)s is %(baz)s!"
# The optional `vars` argument is a dict with members that will take # The optional *vars* argument is a dict with members that will take
# precedence in interpolation. # precedence in interpolation.
print(cfg.get('Section1', 'foo', vars={'bar': 'Documentation', print(cfg.get('Section1', 'foo', vars={'bar': 'Documentation',
'baz': 'evil'})) 'baz': 'evil'}))
# The optional `fallback` argument can be used to provide a fallback value # The optional *fallback* argument can be used to provide a fallback value
print(cfg.get('Section1', 'foo')) print(cfg.get('Section1', 'foo'))
# -> "Python is fun!" # -> "Python is fun!"
......
...@@ -141,11 +141,11 @@ Here is the :class:`Header` class description: ...@@ -141,11 +141,11 @@ Here is the :class:`Header` class description:
Returns an approximation of the :class:`Header` as a string, using an Returns an approximation of the :class:`Header` as a string, using an
unlimited line length. All pieces are converted to unicode using the unlimited line length. All pieces are converted to unicode using the
specified encoding and joined together appropriately. Any pieces with a specified encoding and joined together appropriately. Any pieces with a
charset of `unknown-8bit` are decoded as `ASCII` using the `replace` charset of ``'unknown-8bit'`` are decoded as ASCII using the ``'replace'``
error handler. error handler.
.. versionchanged:: 3.2 .. versionchanged:: 3.2
Added handling for the `unknown-8bit` charset. Added handling for the ``'unknown-8bit'`` charset.
.. method:: __eq__(other) .. method:: __eq__(other)
......
...@@ -575,13 +575,13 @@ properties, will be invoked and :meth:`__getattr__` and :meth:`__getattribute__` ...@@ -575,13 +575,13 @@ properties, will be invoked and :meth:`__getattr__` and :meth:`__getattribute__`
may be called. may be called.
For cases where you want passive introspection, like documentation tools, this For cases where you want passive introspection, like documentation tools, this
can be inconvenient. `getattr_static` has the same signature as :func:`getattr` can be inconvenient. :func:`getattr_static` has the same signature as :func:`getattr`
but avoids executing code when it fetches attributes. but avoids executing code when it fetches attributes.
.. function:: getattr_static(obj, attr, default=None) .. function:: getattr_static(obj, attr, default=None)
Retrieve attributes without triggering dynamic lookup via the Retrieve attributes without triggering dynamic lookup via the
descriptor protocol, `__getattr__` or `__getattribute__`. descriptor protocol, :meth:`__getattr__` or :meth:`__getattribute__`.
Note: this function may not be able to retrieve all attributes Note: this function may not be able to retrieve all attributes
that getattr can fetch (like dynamically created attributes) that getattr can fetch (like dynamically created attributes)
...@@ -589,12 +589,12 @@ but avoids executing code when it fetches attributes. ...@@ -589,12 +589,12 @@ but avoids executing code when it fetches attributes.
that raise AttributeError). It can also return descriptors objects that raise AttributeError). It can also return descriptors objects
instead of instance members. instead of instance members.
If the instance `__dict__` is shadowed by another member (for example a If the instance :attr:`__dict__` is shadowed by another member (for example a
property) then this function will be unable to find instance members. property) then this function will be unable to find instance members.
.. versionadded:: 3.2 .. versionadded:: 3.2
`getattr_static` does not resolve descriptors, for example slot descriptors or :func:`getattr_static` does not resolve descriptors, for example slot descriptors or
getset descriptors on objects implemented in C. The descriptor object getset descriptors on objects implemented in C. The descriptor object
is returned instead of the underlying attribute. is returned instead of the underlying attribute.
......
...@@ -293,7 +293,7 @@ used from the command line. The basic command-line usage is:: ...@@ -293,7 +293,7 @@ used from the command line. The basic command-line usage is::
As a shortcut, ``python -m unittest`` is the equivalent of As a shortcut, ``python -m unittest`` is the equivalent of
``python -m unittest discover``. If you want to pass arguments to test ``python -m unittest discover``. If you want to pass arguments to test
discovery the `discover` sub-command must be used explicitly. discovery the ``discover`` sub-command must be used explicitly.
The ``discover`` sub-command has the following options: The ``discover`` sub-command has the following options:
...@@ -305,11 +305,11 @@ The ``discover`` sub-command has the following options: ...@@ -305,11 +305,11 @@ The ``discover`` sub-command has the following options:
.. cmdoption:: -s directory .. cmdoption:: -s directory
Directory to start discovery ('.' default) Directory to start discovery (``.`` default)
.. cmdoption:: -p pattern .. cmdoption:: -p pattern
Pattern to match test files ('test*.py' default) Pattern to match test files (``test*.py`` default)
.. cmdoption:: -t directory .. cmdoption:: -t directory
...@@ -724,8 +724,8 @@ Test cases ...@@ -724,8 +724,8 @@ Test cases
single test. single test.
.. versionchanged:: .. versionchanged::
`TestCase` can be instantiated successfully without providing a method :class:`TestCase` can be instantiated successfully without providing a method
name. This makes it easier to experiment with `TestCase` from the name. This makes it easier to experiment with :class:`TestCase` from the
interactive interpreter. interactive interpreter.
*methodName* defaults to :meth:`runTest`. *methodName* defaults to :meth:`runTest`.
...@@ -940,17 +940,17 @@ Test cases ...@@ -940,17 +940,17 @@ Test cases
+---------------------------------------------------------+--------------------------------------+------------+ +---------------------------------------------------------+--------------------------------------+------------+
| Method | Checks that | New in | | Method | Checks that | New in |
+=========================================================+======================================+============+ +=========================================================+======================================+============+
| :meth:`assertRaises(exc, fun, *args, **kwds) | ``fun(*args, **kwds)`` raises `exc` | | | :meth:`assertRaises(exc, fun, *args, **kwds) | ``fun(*args, **kwds)`` raises *exc* | |
| <TestCase.assertRaises>` | | | | <TestCase.assertRaises>` | | |
+---------------------------------------------------------+--------------------------------------+------------+ +---------------------------------------------------------+--------------------------------------+------------+
| :meth:`assertRaisesRegex(exc, re, fun, *args, **kwds) | ``fun(*args, **kwds)`` raises `exc` | 3.1 | | :meth:`assertRaisesRegex(exc, re, fun, *args, **kwds) | ``fun(*args, **kwds)`` raises *exc* | 3.1 |
| <TestCase.assertRaisesRegex>` | and the message matches `re` | | | <TestCase.assertRaisesRegex>` | and the message matches *re* | |
+---------------------------------------------------------+--------------------------------------+------------+ +---------------------------------------------------------+--------------------------------------+------------+
| :meth:`assertWarns(warn, fun, *args, **kwds) | ``fun(*args, **kwds)`` raises `warn` | 3.2 | | :meth:`assertWarns(warn, fun, *args, **kwds) | ``fun(*args, **kwds)`` raises *warn* | 3.2 |
| <TestCase.assertWarns>` | | | | <TestCase.assertWarns>` | | |
+---------------------------------------------------------+--------------------------------------+------------+ +---------------------------------------------------------+--------------------------------------+------------+
| :meth:`assertWarnsRegex(warn, re, fun, *args, **kwds) | ``fun(*args, **kwds)`` raises `warn` | 3.2 | | :meth:`assertWarnsRegex(warn, re, fun, *args, **kwds) | ``fun(*args, **kwds)`` raises *warn* | 3.2 |
| <TestCase.assertWarnsRegex>` | and the message matches `re` | | | <TestCase.assertWarnsRegex>` | and the message matches *re* | |
+---------------------------------------------------------+--------------------------------------+------------+ +---------------------------------------------------------+--------------------------------------+------------+
.. method:: assertRaises(exception, callable, *args, **kwds) .. method:: assertRaises(exception, callable, *args, **kwds)
...@@ -1092,7 +1092,7 @@ Test cases ...@@ -1092,7 +1092,7 @@ Test cases
| :meth:`assertNotRegex(s, re) | ``not regex.search(s)`` | 3.2 | | :meth:`assertNotRegex(s, re) | ``not regex.search(s)`` | 3.2 |
| <TestCase.assertNotRegex>` | | | | <TestCase.assertNotRegex>` | | |
+---------------------------------------+--------------------------------+--------------+ +---------------------------------------+--------------------------------+--------------+
| :meth:`assertCountEqual(a, b) | `a` and `b` have the same | 3.2 | | :meth:`assertCountEqual(a, b) | *a* and *b* have the same | 3.2 |
| <TestCase.assertCountEqual>` | elements in the same number, | | | <TestCase.assertCountEqual>` | elements in the same number, | |
| | regardless of their order | | | | regardless of their order | |
+---------------------------------------+--------------------------------+--------------+ +---------------------------------------+--------------------------------+--------------+
...@@ -1887,7 +1887,7 @@ Loading and running tests ...@@ -1887,7 +1887,7 @@ Loading and running tests
.. class:: TextTestRunner(stream=None, descriptions=True, verbosity=1, runnerclass=None, warnings=None) .. class:: TextTestRunner(stream=None, descriptions=True, verbosity=1, runnerclass=None, warnings=None)
A basic test runner implementation that outputs results to a stream. If *stream* A basic test runner implementation that outputs results to a stream. If *stream*
is `None`, the default, `sys.stderr` is used as the output stream. This class is ``None``, the default, :data:`sys.stderr` is used as the output stream. This class
has a few configurable parameters, but is essentially very simple. Graphical has a few configurable parameters, but is essentially very simple. Graphical
applications which run test suites should provide alternate implementations. applications which run test suites should provide alternate implementations.
...@@ -1904,7 +1904,7 @@ Loading and running tests ...@@ -1904,7 +1904,7 @@ Loading and running tests
Added the ``warnings`` argument. Added the ``warnings`` argument.
.. versionchanged:: 3.2 .. versionchanged:: 3.2
The default stream is set to `sys.stderr` at instantiation time rather The default stream is set to :data:`sys.stderr` at instantiation time rather
than import time. than import time.
.. method:: _makeResult() .. method:: _makeResult()
......
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