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

Get doctests to pass #281

Open
jagerber48 opened this issue Dec 30, 2024 · 2 comments
Open

Get doctests to pass #281

jagerber48 opened this issue Dec 30, 2024 · 2 comments

Comments

@jagerber48
Copy link
Contributor

During #279 I discovered that there are doctests in the documentation, however, many are failing. On my tests run 111/204 doctests failed. We should get these doctests to pass. It would also be a good idea to run doctests to run in the CI.

@andrewgsavage
Copy link
Contributor

this would prevent issues like #286 yea

@newville
Copy link
Member

@jagerber48 @andrewgsavage Sorry to be dense, but I don't understand. Are there doctests in the documentation? Where are these? I don't see a single doctest or testcode directive in the rst files.
If there are such tests, how do you run them? I have no idea.

I've always found code in docstrings unreliable for testing, as they may be incomplete snippets. Do we want to run these and count "passing" and "failing"? I could be persuaded, especially if this was included in the CI, but it might be real effort...

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

No branches or pull requests

3 participants