Fix some ReST indentation issues in docstrings

This commit is contained in:
Tim Hoffmann 2019-07-15 16:16:44 +02:00
parent 3ad315bcee
commit 6f1d358a0c
2 changed files with 13 additions and 12 deletions

View File

@ -193,17 +193,18 @@ class MarkDecorator:
pass pass
When a MarkDecorator instance is called it does the following: When a MarkDecorator instance is called it does the following:
1. If called with a single class as its only positional argument and no
additional keyword arguments, it attaches itself to the class so it 1. If called with a single class as its only positional argument and no
gets applied automatically to all test cases found in that class. additional keyword arguments, it attaches itself to the class so it
2. If called with a single function as its only positional argument and gets applied automatically to all test cases found in that class.
no additional keyword arguments, it attaches a MarkInfo object to the 2. If called with a single function as its only positional argument and
function, containing all the arguments already stored internally in no additional keyword arguments, it attaches a MarkInfo object to the
the MarkDecorator. function, containing all the arguments already stored internally in
3. When called in any other case, it performs a 'fake construction' call, the MarkDecorator.
i.e. it returns a new MarkDecorator instance with the original 3. When called in any other case, it performs a 'fake construction' call,
MarkDecorator's content updated with the arguments passed to this i.e. it returns a new MarkDecorator instance with the original
call. MarkDecorator's content updated with the arguments passed to this
call.
Note: The rules above prevent MarkDecorator objects from storing only a Note: The rules above prevent MarkDecorator objects from storing only a
single function or class reference as their positional argument with no single function or class reference as their positional argument with no

View File

@ -542,7 +542,7 @@ def raises(expected_exception, *args, **kwargs):
string that may contain `special characters`__, the pattern can string that may contain `special characters`__, the pattern can
first be escaped with ``re.escape``. first be escaped with ``re.escape``.
__ https://docs.python.org/3/library/re.html#regular-expression-syntax __ https://docs.python.org/3/library/re.html#regular-expression-syntax
:kwparam message: **(deprecated since 4.1)** if specified, provides a custom failure message :kwparam message: **(deprecated since 4.1)** if specified, provides a custom failure message
if the exception is not raised. See :ref:`the deprecation docs <raises message deprecated>` for a workaround. if the exception is not raised. See :ref:`the deprecation docs <raises message deprecated>` for a workaround.