Implement some ad-hoc documentation tests. #699
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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...
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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...