Skip to content

Recommend the canonical timeout method option - #214

Merged
flub merged 1 commit into
pytest-dev:mainfrom
Skytuhua:docs/use-canonical-timeout-method
Oct 31, 2026
Merged

flub merged 1 commit into
pytest-dev:mainfrom
Skytuhua:docs/use-canonical-timeout-method

Conversation

@Skytuhua

Copy link
Copy Markdown
Contributor

The timeout-method section recommends the deprecated --timeout_method spelling. Use --timeout-method, matching the plugin help, while keeping the timeout_method configuration key and historical changelog unchanged.

Validated the installed plugin help, ran an external smoke test with each CLI spelling, rendered the README as HTML, and ran git diff --check.

@Zhuyuyangyy

Copy link
Copy Markdown

Related README detail that may be useful to include here, rather than opening a parallel documentation PR:

On current main (a42e4c5), the Debugger Detection paragraph advertises --disable-debugger-detection, but the registered option is --timeout-disable-debugger-detection. A possible replacement is:

This functionality can be disabled with the
``--timeout-disable-debugger-detection`` flag or the
``timeout_disable_debugger_detection`` ini setting.

This also removes the environment-variable claim: get_env_settings reads this setting from CLI/ini only; its environment-variable lookup is for PYTEST_TIMEOUT.

Verified against that actual HEAD with plugin auto-loading disabled and explicit -p pytest_timeout: the documented flag is rejected with exit 4; the registered flag and -o timeout_disable_debugger_detection=true each run one passing configuration assertion that the setting is True. These are local, finite configuration checks, not the full timeout-behavior suite or remote CI.

Feel free to include this if it fits your scope. AI assistance was used for this check; no code-behavior change is proposed.

@flub
flub merged commit 4103c99 into pytest-dev:main Oct 31, 2026
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants