haddock
haddock copied to clipboard
haskell
Haskell Documentation Tool
This greatly helps when there are problems running haddock tests on GHC's CI because otherwise we get the very unhelpful error message: ``` Failed to run Haddock on test package...
The last arrow in the function `Data.Array.Mutable.Linear.slice` is linear, but is not displayed as such: https://hackage.haskell.org/package/linear-base-0.3.0/docs/Data-Array-Mutable-Linear.html#v:slice
https://github.com/haskell/haddock/blob/a75c08f885207fafbd5dec5bc061cf2f81a7f268/haddock-api/src/Haddock/InterfaceFile.hs#L126 https://github.com/haskell/haddock/actions/runs/4457586699/jobs/7828749016#step:4:14 ``` hlint: #error Unsupported GHC version in haddock-api/src/Haddock/InterfaceFile.hs at line 132 col 1 CallStack (from HasCallStack): error, called at ./Language/Preprocessor/Cpphs/CppIfdef.hs:113:21 in cpphs-1.20.9.1:Language.Preprocessor.Cpphs.CppIfdef hlint completed with status code 1...
**Original reporter**: _justnika@_ As a result you get a doc like in the attached file[[Image(screenshot.png)]]
When generating `html` documentation, it would be nice to automatically render Mermaid diagrams. For example, if some Haskell code contained a comment like ```haskell -- | Some docs with a...
Hi, Sometimes function has complex type signature. Developer would like to define an "alias" with type aliases in the signature to make the function type more concise, but haddock of...
I just noticed that the rendered documentation for [`Data.Semigroup`](https://hackage.haskell.org/package/base-4.17.0.0/docs/Data-Semigroup.html) is missing `@since` annotations for `Generic` and `Generic1` instances. I figured that someone must have forgotten to put them in, but...
A few weeks ago I had to go through a periodo of no net. I worked on some haskell projects and when opening haddock documentation, I noticed the load-wheel kept...
The following code is crashing haddock: ``` {- | +-----+ | ✅ | +-----+ -} module Toto where ``` ``` $ haddock --version Haddock version 2.27.0, (c) Simon Marlow 2006...
