MAINT: Bump scipy-doctest to 1.8 (#29085)

ev-br · web-flow · commit a88d0149ae91 · 2025-06-05T11:00:59.000+02:00
* MAINT: check-docs: require scipy-doctest >= 1.8.0 See for the discussion https://discuss.scientific-python.org/t/scipy-doctest-select-only-doctests-or-both-doctests-and-unit-tests/1950 [docs only] * CI: bump scipy-doctest version on CI [skip azp] [skip actions] [skip cirrus] * MAINT: tweak doctests to not fail
diff --git a/.github/workflows/linux.yml b/.github/workflows/linux.yml
@@ -271,7 +271,7 @@ jobs:
     # - name: Check docstests
     #   shell: 'script -q -e -c "bash --noprofile --norc -eo pipefail {0}"'
     #   run: |
-    #     pip install scipy-doctest==1.6.0 hypothesis==6.104.1 matplotlib scipy pytz pandas
+    #     pip install scipy-doctest>=1.8.0 hypothesis==6.104.1 matplotlib scipy pytz pandas
     #     spin check-docs -v
     #     spin check-tutorials -v
 
diff --git a/.spin/cmds.py b/.spin/cmds.py
@@ -196,13 +196,16 @@ def check_docs(*, parent_callback, pytest_args, **kwargs):
         import scipy_doctest  # noqa: F401
     except ModuleNotFoundError as e:
         raise ModuleNotFoundError("scipy-doctest not installed") from e
+    if scipy_doctest.__version__ < '1.8.0':
+        raise ModuleNotFoundError("please update scipy_doctests to >= 1.8.0")
 
     if (not pytest_args):
         pytest_args = ('--pyargs', 'numpy')
 
     # turn doctesting on:
     doctest_args = (
         '--doctest-modules',
+        '--doctest-only-doctests=true',
         '--doctest-collect=api'
     )
 
diff --git a/numpy/_core/_add_newdocs.py b/numpy/_core/_add_newdocs.py
@@ -5944,7 +5944,7 @@
     >>> import numpy as np
     >>> dt = np.dtype([('name', np.str_, 16), ('grades', np.float64, (2,))])
     >>> print(dt.fields)
-    {'name': (dtype('|S16'), 0), 'grades': (dtype(('float64',(2,))), 16)}
+    {'name': (dtype('<U16'), 0), 'grades': (dtype(('<f8', (2,))), 64)}
 
     """))
 
diff --git a/numpy/lib/introspect.py b/numpy/lib/introspect.py
@@ -34,7 +34,7 @@ def opt_func_info(func_name=None, signature=None):
     ...     func_name="add|abs", signature="float64|complex64"
     ... )
     >>> import json
-    >>> print(json.dumps(dict, indent=2))
+    >>> print(json.dumps(dict, indent=2))   # may vary (architecture)
         {
           "absolute": {
             "dd": {
diff --git a/requirements/doc_requirements.txt b/requirements/doc_requirements.txt
@@ -19,7 +19,7 @@ toml
 
 
 # for doctests, also needs pytz which is in test_requirements
-scipy-doctest==1.6.0
+scipy-doctest>=1.8.0
 
 # interactive documentation utilities
 # see https://github.com/jupyterlite/pyodide-kernel#compatibility

Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@ def opt_func_info(func_name=None, signature=None):`
`34`	`34`	`... func_name="add\|abs", signature="float64\|complex64"`
`35`	`35`	`... )`
`36`	`36`	`>>> import json`
`37`		`- >>> print(json.dumps(dict, indent=2))`
	`37`	`+ >>> print(json.dumps(dict, indent=2)) # may vary (architecture)`
`38`	`38`	`{`
`39`	`39`	`"absolute": {`
`40`	`40`	`"dd": {`