haddock
haddock copied to clipboard
Haskell Documentation Tool
This is a discussion thread. Please correct me where I'm wrong. It's just to put down a big feature idea I've been thinking of for some time in one place,...
@jgm @alexbiehl @gbaz This is following up the discussion in https://github.com/haskell/haddock/pull/729. I'm opening a new issue despite https://github.com/haskell/haddock/issues/244 and https://github.com/haskell/haddock/issues/570 because I'd like to focus on the particular issues around...
I tried building ghc-9.2.1-alpha2 on Fedora armv7hl and it runs out of memory somehow: `GHC.Tc.Gen.HsType.tc_ihaddock: out of memory` I originally [reported this to ghc](https://gitlab.haskell.org/ghc/ghc/-/issues/19754) 2 days ago, not noticing the...
There is a [`haddock-library-1.10.0` on hackage](https://hackage.haskell.org/package/haddock-library-1.10.0), but latest commit on the default branch (`ghc-9.2`) says `1.9.0`: https://github.com/haskell/haddock/blob/bf9125b9d5a101eff316a059b614af3c3ea2d6b4/haddock-library/haddock-library.cabal#L3
Example: https://hackage.haskell.org/package/bytestring-0.11.1.0/docs/src/Data.ByteString.Lazy.Internal.html#eq 
Place the following snippet in a cabal file and run `cabal new-haddock`: ``` Description: Bla [link](http://example.com) ``` Result:  Removing the newline fixes the issue. A link at the beginning...
If I search for `runST` in https://hackage.haskell.org/package/base-4.16.0.0, the first "proper" (i.e. non-`GHC.`) module shown is `Control.Monad.ST.Safe`, which is deprecated. I'm usually not very interested in deprecated things, so my suggestion...
There's a special case where a `@since` annotation on an instance can be just as annoying as it is helpful: when the instance has existed for as long as the...
Since the support for REPL ("interactive", >>>-) examples was added 12 years ago (28bd97759174c9169b7633ee45d39c82fd069dd9), it had this strong/bold decoration. I don't see a reason for that and find REPL-heavy examples...
In my file I have the following: ```haskell import qualified Data.List as List (foldl', foldl1') -- | A total variant of `List.foldl1\'` foldl1' :: (a -> a -> a) ->...