Skip to content

Commit 7d4c413

Browse files
pkochflub
authored andcommitted
Milder language on README
As per #124 (comment)
1 parent 5aff2a9 commit 7d4c413

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

README.rst

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,15 @@ pytest-timeout
1919
.. |pre-commit| image:: https://results.pre-commit.ci/badge/github/pytest-dev/pytest-timeout/master.svg
2020
:target: https://results.pre-commit.ci/latest/github/pytest-dev/pytest-timeout/master
2121

22-
**This is not the timeout you are looking for!**
2322

2423
.. warning::
2524

2625
Please read this README carefully and only use this plugin if you
27-
understand the consequences. Remember your test suite needs to be
28-
**fast**, timeouts are a last resort not an expected failure mode.
26+
understand the consequences. This plugin is designed to catch
27+
excessively long test durations like deadlocked or hanging tests,
28+
it is not designed for precise timings or performance regressions.
29+
Remember your test suite should aim to be **fast**, with timeouts
30+
being a last resort, not an expected failure mode.
2931

3032
This plugin will time each test and terminate it when it takes too
3133
long. Termination may or may not be graceful, please see below, but

0 commit comments

Comments
 (0)