Skip to content

Conversation

@ev-br
Copy link
Member

@ev-br ev-br commented May 24, 2025

The default is True, for now.

The plan is to make it False in v2.0, so that

$ pytest --doctest-modules
runs both doctests and regular tests (consistent which vanilla doctest), and then the current behavior (== only run doctests) will require

$ pytest --doctest-modules --doctest-only-doctests=true

cross-ref gh-198

TODO

  • add a note to README, in big bold letters

@ev-br ev-br added the enhancement New features w.r.t. the original refguide-check label May 24, 2025
@ev-br ev-br mentioned this pull request May 24, 2025
@ev-br ev-br added this to the v1.8 milestone May 25, 2025
The default is True, for now.

The plan is to make it False in v2.0, so that

$ pytest --doctest-modules

runs both doctests and regular tests (consistent which vanilla doctest),
and then the current behavior (== only run doctests) will require

$ pytest --doctest-modules --doctest-only-doctests=true
@ev-br
Copy link
Member Author

ev-br commented May 29, 2025

Okay, adding a CLI flag does not seem controversial, and is backwards compatible. Merging.

@ev-br ev-br merged commit 827a054 into main May 29, 2025
14 checks passed
@ev-br ev-br deleted the doctest-only branch May 29, 2025 14:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New features w.r.t. the original refguide-check

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants