nnpdf icon indicating copy to clipboard operation
nnpdf copied to clipboard

Run documentation examples using doctest

Open siranipour opened this issue 4 years ago • 1 comments

Often times I stumble across examples that no longer working because a new dependencies has been introduced somewhere upstream in the execution graph.

We should check that all docstrings works using doctest, however, if I run it now I get a lot of tests failing because the tests are not in the correct format.

siranipour avatar Oct 07 '21 11:10 siranipour

I think doing something in that direction would be good. We still have a relatively small fraction of the api exposed in tests and this would help quite effectively.

Is there a way of making doctest run on marked examples only rather than everywhere?

Zaharid avatar Oct 07 '21 14:10 Zaharid