- description: |
Fixed issues in MonadWarning's Haddock page and improved explanations
type:
- documentation # change in code docs, haddocks...
Context
It turns out that putting things in simple quotes in Haddock to create links and highlight them only works if they are a single identifier, and it doesn't work for things like [String], so I have replaced the single quotes in those that don't work with @s and also I have improved the documentation overall, by making sure things show up properly.
How to trust this PR
It is essentially just comment changes, and adding two types to the export list (without constructors), in order for the Haddock to make more sense. The best way to review it is really to just generate the Haddock, but that takes a long time, so I would look for typos and things like that.
Checklist
[x] Commit sequence broadly makes sense and commits have useful messages
[x] New tests are added if needed and existing tests are updated. See Running tests for more details
Changelog
Context
It turns out that putting things in simple quotes in Haddock to create links and highlight them only works if they are a single identifier, and it doesn't work for things like
[String], so I have replaced the single quotes in those that don't work with@s and also I have improved the documentation overall, by making sure things show up properly.How to trust this PR
It is essentially just comment changes, and adding two types to the export list (without constructors), in order for the Haddock to make more sense. The best way to review it is really to just generate the Haddock, but that takes a long time, so I would look for typos and things like that.
Checklist