haddock
haddock copied to clipboard
haskell
Haskell Documentation Tool
Does haddock accept HTML fragments? In the [numhask](https://hackage.haskell.org/package/numhask-0.10.1.0) haddock, I have an svg image in the docs, and haddock renders: ```  ``` as ``` ``` The image would be...
Current haddock head of `ghc-9.2` branch (041385bc43f0b99d26077787eb8ed9e394766438) renders `toLazyTMVar` defined by: ``` newtype StrictTMVar m a = StrictTMVar { toLazyTMVar :: LazyTMVar m a } ``` as ``` $sel:toLazyTMVar:StrictTMVar ```...
There is an inconsistency in how html filenames are generated for haddock vs. source documentation. Compare 1. haddock: https://hackage.haskell.org/package/base-4.16.0.0/docs/src/Data.Bifoldable.html -> source files under "docs/src" folder contain dot as module separator...
See as an example [this index page on hackage](https://hackage.haskell.org/package/xml-1.3.14/docs/doc-index-A.html). Having: attrib :: LString -> (String, LString) would be better than current layout (plain attrib, no sig, just module link). see...
The documentation of [`GHC.Generics`](https://hackage.haskell.org/package/base-4.15.0.0/docs/GHC-Generics.html) shows the instance for `Generic1 Solo`, but not the instance for `Generic (Solo a)`. The instance is definitely there; indeed, if you click through to the...
The following haddock comment ... -- | ...a .... {-| Prefix: xyz Characteristics * does this and this * e.g. bla... (' \0') * e.g. ... (' ') * e.g....
NB. I originally filed this as a GHC issue (https://gitlab.haskell.org/ghc/ghc/-/issues/19578) as it sounds to me like a GHC issue, but I was told to file here as a Haddock one....
about the usage of HLint in the codebase. I am not against it, but I would rather have a fixed set of lints to follow before reviewing linting PRs. _Originally...
With the landing of Hi Haddock, I'd like to take some time to think about what we want to focus on for the year 2022. ## Some things that need...
