Skip to content

Commit e7884b7

Browse files
committed
..
1 parent 764be33 commit e7884b7

File tree

1 file changed

+5
-7
lines changed

1 file changed

+5
-7
lines changed

README.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -318,7 +318,7 @@ $ spin smoke-tutorials # ReST user guide tutorials
318318

319319
Here is a (non-exhaustive) list of possible gotchas:
320320

321-
- _In-place development builds_.
321+
#### _In-place development builds_.
322322

323323
Some tools (looking at you `meson-python`) simulate in-place builds with a
324324
`build-install` directory. If this directory is located under the project root,
@@ -342,7 +342,7 @@ If push really comes to shove, you may try using the magic env variable:
342342
however the need usually indicates an issue with the package itself.
343343
(see [gh-107](https://github.com/scipy/scipy_doctest/pull/107) for an example).
344344

345-
- _Optional dependencies are not that optional_
345+
#### _Optional dependencies are not that optional_
346346

347347
If your package contains optional dependencies, doctests do not know about them
348348
being optional. So you either guard the imports in doctests themselves (yikes!), or
@@ -361,7 +361,7 @@ Note that installed packages are no different:
361361
$ pytest --pyargs scipy --doctest-modules --ignore=/path/to/installed/scipy/_lib
362362
```
363363

364-
- _Doctest collection strategies_
364+
#### _Doctest collection strategies_
365365

366366
The default collection strategy follows `doctest` module and `pytest`. This leads
367367
to duplicates if your package has the split between public and \_private modules,
@@ -383,9 +383,7 @@ leads to
383383
* `scipy.linalg._basic.det`, collected from `scipy/linalg/_basic.py`, is private.
384384
* `scipy.linalg.det`, collected from `scipy/linalg/__init__.py`, is public.
385385

386-
<!-- -->
387-
388-
- _`pytest`'s assertion rewriting_
386+
#### _`pytest`'s assertion rewriting_
389387

390388
In some rare cases you may need to either explicitly register the `scipy_doctest`
391389
package with the `pytest` assertion rewriting machinery, or ask it to avoid rewriting
@@ -397,7 +395,7 @@ In general, rewriting assertions is not very useful for doctests, as the
397395
output on error is fixed by the doctest machinery anyway. Therefore, we believe
398396
adding `--assert=plain` is reasonable.
399397

400-
- _Mixing strings and numbers_
398+
#### _Mixing strings and numbers_
401399

402400
Generally, we aim to handle mixtures of strings and numeric data. Deeply nested data
403401
structures however may cause the checker to fall back to the vanilla `doctest` literal

0 commit comments

Comments
 (0)