Skip to content

Commit e46582c

Browse files
committed
Fix rst admonition formatting
1 parent 0f0a043 commit e46582c

File tree

1 file changed

+16
-13
lines changed

1 file changed

+16
-13
lines changed

README.rst

Lines changed: 16 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -23,21 +23,24 @@ This is useful when running tests under a continuous
2323
integration server or simply if you don't know why the test suite hangs.
2424

2525
.. note::
26-
The way this plugin detects whether or not a debugging session is active
27-
is by checking if a trace function is set and if one is, it check to see
28-
if the module it belongs to is present in a set of known debugging
29-
frameworks modules OR if pytest itself drops you into a pbd session.
26+
27+
The way this plugin detects whether or not a debugging session is
28+
active is by checking if a trace function is set and if one is, it
29+
check to see if the module it belongs to is present in a set of
30+
known debugging frameworks modules OR if pytest itself drops you
31+
into a pbd session.
3032

3133
.. note::
32-
While by default on POSIX systems pytest will continue to
33-
execute the tests after a test has timed out this is not always
34-
possible. Often the only sure way to interrupt a hanging test is by
35-
terminating the entire process. As this is a hard termination
36-
(``os._exit()``) it will result in no teardown, JUnit XML output etc.
37-
But the plugin will ensure you will have the debugging output on
38-
stderr nevertheless, which is the most important part at this stage.
39-
See below for detailed information on the timeout methods and their
40-
side-effects.
34+
35+
While by default on POSIX systems pytest will continue to execute
36+
the tests after a test has timed out this is not always possible.
37+
Often the only sure way to interrupt a hanging test is by
38+
terminating the entire process. As this is a hard termination
39+
(``os._exit()``) it will result in no teardown, JUnit XML output
40+
etc. But the plugin will ensure you will have the debugging output
41+
on stderr nevertheless, which is the most important part at this
42+
stage. See below for detailed information on the timeout methods
43+
and their side-effects.
4144

4245
The pytest-timeout plugin has been tested on python 2.7 or higher,
4346
including 3.X, pypy and pypy3. See tox.ini for currently tested

0 commit comments

Comments
 (0)