From 7d4c413a6344edd8340628354419a324e68c6cb7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Paulo=20K=C3=B6ch?= Date: Mon, 18 Jul 2022 19:29:25 +0100 Subject: [PATCH] Milder language on README As per https://github.com/pytest-dev/pytest-timeout/issues/124#issuecomment-1155633546 --- README.rst | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.rst b/README.rst index 9533d22..7a5448b 100644 --- a/README.rst +++ b/README.rst @@ -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