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

Implement some ad-hoc documentation tests. #699

Merged
merged 1 commit into from Jun 22, 2017

Conversation

Projects
None yet
1 participant
@jmchilton
Copy link
Member

jmchilton commented Jun 21, 2017

I just walked through the documentation and turned the examples into little bash scripts that can be executed and the result inspected to quickly test planemo-machine in an ongoing fashion. I intend to create a pre-GCC checklist for planemo-machine and I'll put reviewing these scripts against the docs on that.

I guess the next step would be actually annotate the docs - I should do that. Also these should probably be an Jupyter script instead of a bash script? Extract commands from RST into a Jupyter notebook - a bit that exists - or maybe we should go the other way. Who knows...

Implement some ad-hoc documentation tests.
I just walked through the documentation and turned the examples into little bash scripts that can be executed and the result inspected to quickly test planemo-machine in an ongoing fashion. I intend to create a pre-GCC checklist for planemo-machine and I'll put reviewing these scripts against the docs on that.

I guess the next step would be actually annotate the docs - I should do that. Also these should probably be an Jupyter script instead of a bash script? Extract commands from RST into a Jupyter notebook - a bit that exists - or maybe we should go the other way. Who knows...

@jmchilton jmchilton merged commit c92eb2c into galaxyproject:master Jun 22, 2017

1 check passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment