Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

TST Favor doctests over notebook testing #331

Open
drewejohnson opened this issue Aug 30, 2019 · 0 comments
Open

TST Favor doctests over notebook testing #331

drewejohnson opened this issue Aug 30, 2019 · 0 comments
Labels
documentation testing Related to our test suite
Projects

Comments

@drewejohnson
Copy link
Collaborator

I propose that we integrate tests into our documentation through doctests rather than rely on converting jupyter notebooks to python and then running them.
This has a few benefits:

  1. We can ensure that our documentation is correct while we right the documentation - Sphinx guide on doctest extension
  2. Once we move to pytest via ENH Transition to pytest for all testing #325, we can pick these up in the project testing and CI - pytest doctest integration
  3. We can remove the need to keep and track the jupyter notebooks in the examples directory. These do provide some benefit, so we may want to move them somewhere, or figure out if we can generate a notebook from the documentation.

The main issue with keeping jupyter notebooks and example documentation is that we have to update both in the event of API changes. The notebooks are difficult to diff unless you use nbdime. I am open to keeping the notebooks, but then we have to make sure that, when there are API changes, both the documentation and the example notebooks get updated.

@drewejohnson drewejohnson added this to the 0.8.0 milestone Aug 30, 2019
@drewejohnson drewejohnson added this to To do in Main Aug 31, 2019
@drewejohnson drewejohnson removed this from the 0.8.0 milestone Sep 8, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation testing Related to our test suite
Projects
Main
To do
Development

No branches or pull requests

1 participant