Test haddock documentation using doctest#21
Merged
Merged
Conversation
fpringle
force-pushed
the
fpringle/doctests
branch
from
4227445 to
de8156d
Compare
fpringle
force-pushed
the
fpringle/doctests
branch
from
de8156d to
7265070
Compare
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Closes #17.
Using
doctestwe can test the examples in our Haddock comments.I originally tried to run the doctests as part of the CICD (tried both
doctestanddoctest-parallel), but it kept failing. So now it's a pre-push git hook.Also closes #4 and #5.