-
-
Notifications
You must be signed in to change notification settings - Fork 10.8k
DRAFT: enabling doctestplus #23812
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
DRAFT: enabling doctestplus #23812
Conversation
@bsipocz I pushed a small fix for a merge conflict. But, could you remind me of the correct incantation (currently?), I already added:
to the
so I think I am probably just approaching running EDIT: I think the problem was only that I didn't add |
There are now quite a few plots popping up again and failures due to deprecations. Maybe we should just ignore deprecation warnings in the docs. Or if we don't want to do that, just remove the examples for clearly deprecated functionality? |
+1 |
Would a rebase help clear some of the collection issues? |
# NumPy should probably use more `.. plot::` directives even in | ||
# examples, but as long as we don't, do not block on `plt.show()` | ||
import matplotlib | ||
matplotlib.use("Agg") |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@bsipocz where could this go and is this OK? This fixes the plt.show()
not popping up things. There are some that can just be plot directives, but the histogram re-uses the data and has comments, etc. so I thought this is the easier path.
Maybe we need distinct runs, also so that we can make sure that warnings
are not raised as errors?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Indeed, this should be the fix for the mpl pop ups.
As for warnings, I think they really should be raised as errors, unless they are handled properly. For doctestplus we can use either +IGNORE_WARNINGS
or +SHOW_WARNINGS
I think the collection issues are maybe all expected, i.e. trying to find doctests in places we shouldn't look or just something to do with how I ran it. |
Thanks Sebastian for the commits! I'm sorry for being too slow with this, I'm trying to come back to it in a more timely manner. |
67a9ae5
to
c7bdebf
Compare
I'll note that the tool we currently use is If you want to iterate on CI, perhaps easiest to use that same job (or port it to a single GHA job). |
The file uses too many things that assume a layout and almost nothing can be doctested anyway
It just doesn't hurt, in case its run, this file is only interesting historically and could probably be moved out as well.
Yes, I think so. I think it's a pitty that we couldn't merge the approaches instead of having one tool doing the same another, less generically used was built up, but whatever. |
This is a WIP, and I'm opening a PR only to enable @seberg to push to this branch directly.