Improve doctests #242
Merged
Improve doctests #242
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
1. Actually run the doctests in "Tutorial.hs".
This commit also updates those doctests to
match current expected types and behavior.
2. Convert doctests in test-only code to ordinary unit tests because:
a. Because they are in test-only code they do not actually provide
any documentation despite being expressed as doctests, and
b. It seems that doctests tend to be fragile when upgrading GHC or
dependencies, especially the ones found in "TestCodeGen.hs".
riz0id
approved these changes
Sep 25, 2023
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.
Actually run the doctests in "Tutorial.hs". This commit also updates those doctests to match current expected types and behavior.
Convert doctests in test-only code to ordinary unit tests because:
a. Because they are in test-only code they do not actually provide
any documentation despite being expressed as doctests, and
b. It seems that doctests tend to be fragile when upgrading GHC or
dependencies, especially the ones found in "TestCodeGen.hs".