pytest-dev / pytest-timeout

MIT License
216 stars 64 forks source link

[Docs] Clearly state that timeout value applies to a test, not test session #34

Closed pytest-timeout-bot closed 4 years ago

pytest-timeout-bot commented 5 years ago

Original report by Андрей Парамонов (Bitbucket: aparamon, GitHub: aparamon).


Currently, docs say:

This is a plugin which will terminate tests after a certain timeout. When doing so it will show a stack dump of all threads running at the time. This is useful when running tests under a continuous integration server or simply if you don’t know why the test suite hangs.

It seems that the plugin will terminate the long-running test suite (i.e. timeout applies to the test session), however in reality timeout applies to every test item, independently.

It is proposed to re-phrase:

This is a plugin which terminates a test after a certain timeout.

pytest-timeout-bot commented 5 years ago

Original comment by Floris Bruynooghe (Bitbucket: flub, GitHub: flub).


Seems good, would you like to do this in a PR?