Implement tests for Hissp REPL examples in documentation #13
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
It's too bad they can't support the same markdown.
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.
Sybil is now required to run these documentation tests.
The custom Sybil parser/evaluator only tests that the Lissp compiles to the expected Python. It does evaluate the results so it can update the document's namespace for future tests, but checking the output is left to doctest. This means the tests have to be run twice, but it also means that we get doctest's feature's for (like
+ELLIPSIS) for free.It only works on the README.md at the moment, but with some tweaks it could probably be made to run in
.rstand.lisspfiles as well, which means our end-users might want it. I don't want to introduce a dependency for the PyPI package, but perhaps this could be split off into a separate project.