Correct README.md examples and outputs using doctest #351
+156
−33
Conversation
This file contains 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
|
Yeah, you're right. README was supposed to be used in tests, and it was, but probably between migrating from one CI system to another it was forgotten. It would be nice to add it to GitHub actions when all the tests pass. |
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.
The 'README.md' contains numerous examples and expected outputs, but these don't appear to be regularly tested.
I added the formatting necessary to run "doctest" on the README.md and test the expected outputs. Mostly this was just adding a doctest-terminating blank line after the expected outputs. However, several of the tests showed some differences in output.
Check that these are indeed now correct, and then this should be ready to merge.
I also added instructions on how to run doctest on the
README.md.