@@ -151,6 +151,22 @@ $ pytest --pyargs <your-package> --doctest-modules --doctest-collect=api
151
151
See [ More fine-grained control] ( #more-fine-grained-control ) section
152
152
for details on how to customize the behavior.
153
153
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 ` .
159
+
160
+ To retain the current behavior, use the ` --doctest-only-doctests ` CLI option:
161
+
162
+ ```
163
+ $ pytest --doctest-modules --doctest-only-doctests
164
+ ```
165
+
166
+ is unambiguous and will behave identically in the current version 1.8 and upcoming
167
+ versions of ` scipy-doctest ` .
168
+
169
+
154
170
### Basic usage
155
171
156
172
The use of ` pytest ` is optional, and you can use the ` doctest ` layer API.
@@ -291,11 +307,11 @@ NumPy wraps `scipy-doctest` with the `spin` command
291
307
$ spin check-docs
292
308
```
293
309
294
- SciPy wraps ` scipy-doctest ` with custom ` dev.py ` commands :
310
+ In SciPy, the name of the ` spin ` command is ` smoke-docs ` : :
295
311
296
312
```
297
- $ python dev.py smoke-docs # check docstrings
298
- $ python dev.py smoke-tutorials # ReST user guide tutorials
313
+ $ spin smoke-docs # check docstrings
314
+ $ spin smoke-tutorials # ReST user guide tutorials
299
315
```
300
316
301
317
## Rough edges and sharp bits
0 commit comments