-
Notifications
You must be signed in to change notification settings - Fork 267
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
untested examples? #931
Comments
agreed - eventually however I think they may all move to notebooks that get automatically inserted into the documentation (as we discussed), but that may take some time. So for now, we could just execute them like we do the notebooks... They are sort of integration tests, so we could make a tests/ directory with a test-runner that marks them as |
We can also then identify which ones are outdated and should be removed. A few might be useful to turn into real Tools (and move to |
Karl works on this in #941 |
@kosack I think this can be closed by now? |
Let me check - I think we can probably remove the examples directory, but I would like to move a few into notebooks. The only example I use that i find very useful for debugging is |
The This should be either moved to docstrings, example notebooks or removed. In the current state of this repo, the issue is still valid. |
yes, following what I said above - I will make a PR that moves anything useful to notebooks. |
Could also be docstrings of classes (e.g. the |
This is basically a duplicate of #657, closing this one |
I believe none of the examples in
ctapipe/example
is currently tested in a pytest.I think untested examples can easily outdate and then confuse more than they help.
The text was updated successfully, but these errors were encountered: