Closed slarson closed 10 years ago
Also, here's a link to the new version of the docs from the alpha0.5 directory -- every time that branch is updated it will auto refresh in a minute: http://pyopenworm.readthedocs.org/en/alpha0.5/
Regarding examples I've started an examples dir in my testing branch: https://github.com/openworm/PyOpenWorm/tree/test_network/examples.
It would be really great to get short, well written examples of how the API can be used in here, and these can also be easily run as part of the testing process, e.g. https://github.com/NeuralEnsemble/libNeuroML/blob/master/.travis.yml
Glad you are doing that, @pgleeson !
I would just point out that there are some short examples per API signature inlined over here as well: http://pyopenworm.readthedocs.org/en/alpha0.5/api.html
When you say examples that can be run as part of the testing process, does this mean the examples run outside of a unit testing framework though?
Yes, running these examples on travis is not exactly performing unit tests, but it is a good way to ensure the examples still run with each update to the code
Draw examples out of the test cases you have built. Always good to update docs in sync with the update to the code!