Use doctest module to verify examples in README.md #262
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
Locally, I'm testing `README.md` like this:
$ source venv/bin/activate; python3 -m doctest -v README.md; deactivate
`$ make readme` cleans up Redis, runs the doctests, then cleans up Redis again. This way, I don't have to pollute `README.md` with Redis cleanup commands.
|
As of the last commit, we can test the code examples in |
1. Indicate number of Redis keys deleted (when cleaning up) 2. Reduce verbosity of tests (only print failures)
|
🐟 |
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.
Locally, I'm testing
README.mdlike this: