-
Notifications
You must be signed in to change notification settings - Fork 46
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
Extend the examples in getting_started.rst
and run them as unit tests
#210
Comments
This was referenced Apr 1, 2021
Adding more examples is not critical for 1.0.0, so I'm removing this issue from the milestone. |
22 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
The examples in
getting_started.rst
are a bit limited and could be extended (in line with the manuscript). They should also be tested in the unit tests to make sure they keep working. This can be accomplished by writing them as python scripts in theiodata/test/data
directory. These files can be easily accessed by the unit tests and included in the documentation with the literalinclude directive.The text was updated successfully, but these errors were encountered: