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

Extend the examples in getting_started.rst and run them as unit tests #210

Open
1 of 2 tasks
tovrstra opened this issue Sep 1, 2020 · 1 comment
Open
1 of 2 tasks

Comments

@tovrstra
Copy link
Member

tovrstra commented Sep 1, 2020

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 the iodata/test/data directory. These files can be easily accessed by the unit tests and included in the documentation with the literalinclude directive.

@tovrstra
Copy link
Member Author

Adding more examples is not critical for 1.0.0, so I'm removing this issue from the milestone.

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

1 participant