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

Should we run tests on docstrings? #3837

Closed
max-sixty opened this issue Mar 6, 2020 · 2 comments · Fixed by #4408
Closed

Should we run tests on docstrings? #3837

max-sixty opened this issue Mar 6, 2020 · 2 comments · Fixed by #4408

Comments

@max-sixty
Copy link
Collaborator

max-sixty commented Mar 6, 2020

Currently almost none of the docstrings pass running pytest --doctest-modules xarray/core, though mostly for easy reasons.

Should we run these in CI?

I've recently started using docstring tests in another project, and they've work pretty well.

CC @keewis

@keewis
Copy link
Collaborator

keewis commented Mar 6, 2020

👍 for running doctest in CI, this should help us keep the examples in sync with the implementation

@dcherian
Copy link
Contributor

dcherian commented Mar 6, 2020

I second this. It seems to run quite quickly...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants