Skip to content

docs(repeat): clarify doctest repetition limits - #102

Open
awais-ur-rehman wants to merge 1 commit into
pytest-dev:mainfrom
awais-ur-rehman:feat/docs-doctest-repeat-support
Open

awais-ur-rehman wants to merge 1 commit into
pytest-dev:mainfrom
awais-ur-rehman:feat/docs-doctest-repeat-support

Conversation

@awais-ur-rehman

Copy link
Copy Markdown

Summary

The README says every test collected by pytest repeats, but doctests run once even when --count is greater than one. Limit that statement to pytest test functions and explain the behavior for module and text-file doctests, following the documentation request in #41.

Related to #41. This documents existing behavior.

Breaking changes

None.

Testing

  • On macOS arm64 with Python 3.12.13, uv run --with tox tox -e py312-pytest8,flake8: all 16 repository tests and Flake8 pass; the same test suite passes on unchanged main.
  • Eight external mixed-suite probes cover module/text-file doctests and all four repeat scopes: each doctest runs once and each ordinary function runs twice with --count=2.
  • Baseline and changed README render as RST without warnings; wheel/sdist builds, strict Twine checks, wheel contents checks, and git diff --check pass.
  • Other Python versions, operating systems, and hosted CI were not run locally.

OpenAI Codex assisted with this documentation change and validation.

This branch has not been deployed

No deployments
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.

1 participant