Skip to content

Commit

Permalink
Milder language on README
Browse files Browse the repository at this point in the history
  • Loading branch information
pkoch authored and flub committed Jul 20, 2022
1 parent 5aff2a9 commit 7d4c413
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,13 +19,15 @@ pytest-timeout
.. |pre-commit| image:: https://results.pre-commit.ci/badge/github/pytest-dev/pytest-timeout/master.svg
:target: https://results.pre-commit.ci/latest/github/pytest-dev/pytest-timeout/master

**This is not the timeout you are looking for!**

.. warning::

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

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

0 comments on commit 7d4c413

Please sign in to comment.