Resolve Haddock out-of-scope identifier warnings #404
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
Fix all broken Haddock links. Now Haddock doesn't emit any warnings about out-of-scope identifiers. Warnings about unknown link destinations are more complicated to resolve and are not handled in this commit.
pgujjula
commented
May 21, 2024
| That's because GHCi will default any type variables in your property to '()', so in the example | ||
| above @quickCheck@ was really testing that '()' is equal to itself. To avoid this behaviour it | ||
| That's because GHCi will default any type variables in your property to @()@, so in the example | ||
| above @quickCheck@ was really testing that @()@ is equal to itself. To avoid this behaviour it |
There was a problem hiding this comment.
() is not actually in the Haddocks for Prelude, so linking to () would require pulling in ghc-prim as a dependency. So we just make () monospaced instead of linking to it.
|
Would you mind rebasing on |
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.
Fix all broken Haddock links. Now Haddock doesn't emit any warnings about out-of-scope identifiers. Warnings about unknown link destinations more complicated to resolve and are not handled in this PR.