Docs: Specialised re-exports with better docs & other improvements #51
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
…ised <|> and pure combinators
…y* and some* combinators
… ≥ 9.6 has ambiguous reference to liftA2
|
all devops and no play makes david a dull boy |
|
Lol |
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.
Closes #41.
The re-exports of combinators from
Control.Applicativeetc means we were stuck with their old documentation, which was not very descriptive.The goal of this PR is to improve the documentation for these combinators.
This is achieved by defining a cpp macro
__HADDOCK__that is only defined during the documentation generation, not during the build.This lets us provide re-definitions of the re-exports, having better documentation and specialised types only in the documentation; the actual library still uses the original re-exports.
The major changes are altering the workflow
yamland slightly changing some of the imports throughout the library to make sure they don't accidentally point to the specialised versions during the documentation type check.