Docs: use cabal's predefined __HADDOCK_VERSION__ macro instead of custom __HADDOCK__ macro.
#58
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
… as the former is automatically defined by cabal
…g CPP macros to handle the API incompatibility between versions
j-mie6
approved these changes
Nov 30, 2024
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.
I was reading through the cabal docs, and found they automatically define the CPP macro
__HADDOCK_VERSION__duringcabal haddock.I think it is better to use this as it requires less effort to ensure haddock is supplied the right arguments.
I've replaced all uses of our custom
__HADDOCK__macro to use the predefined__HADDOCK_VERSION__, and have updated the github action to respect this. (The github action basically is the original one before we added the__HADDOCK__macro).