Skip to content

Commit 90c38c9

Browse files
committed
DOC: update the README for the --doctest-only-doctests change
1 parent a9cf0d0 commit 90c38c9

File tree

1 file changed

+9
-10
lines changed

1 file changed

+9
-10
lines changed

README.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -151,21 +151,20 @@ $ pytest --pyargs <your-package> --doctest-modules --doctest-collect=api
151151
See [More fine-grained control](#more-fine-grained-control) section
152152
for details on how to customize the behavior.
153153

154-
**NOTE** Currently, `pytest --doctest-modules` only collects doctests and skips
155-
'regular' unit tests. This differs from the vanilla `pytest` behavior, which collects
156-
both doctests and unit tests.
157-
The behavior will change in a future version: `scipy-doctest==2.0` **will change the
158-
default** to align with the vanilla `pytest`.
154+
**NOTE** In versions 1.x, `pytest --doctest-modules` was only collecting doctests, and
155+
skipped 'regular' unit tests. This differed from the vanilla `pytest` behavior, which
156+
collects both doctests and unit tests.
159157

160-
To retain the current behavior, use the `--doctest-only-doctests` CLI option:
158+
The behavior was changed in version 2.0: from `scipy-doctest==2.0` the default was
159+
changed to align with the vanilla `pytest`.
160+
161+
To retain the previous behavior and skip 'regular' unit tests, use the
162+
`--doctest-only-doctests` CLI option:
161163

162164
```
163-
$ pytest --doctest-modules --doctest-only-doctests
165+
$ pytest --doctest-modules --doctest-only-doctests=true
164166
```
165167

166-
is unambiguous and will behave identically in the current version 1.8 and upcoming
167-
versions of `scipy-doctest`.
168-
169168

170169
### Basic usage
171170

0 commit comments

Comments
 (0)