Skip to content
Snippets Groups Projects
Select Git revision
  • wip/ghc-9.6.7-backports
  • ghc-9.10 protected
  • wip/9.10-hyperlinker-2
  • wip/9.10-hyperlinker
  • wip/T783-9.10
  • ghc-subtree-import-may-2024 protected
  • wip/fendor/os-string-modlocation-haddock
  • wip/fix-T24703
  • wip/fendor/ghc-iface-sharing-avoid-reserialisation-haddock
  • wip/multiline-strings
  • wip/fendor/binary-relative-offsets
  • ghc-head default protected
  • wip/fendor/ifacetype-deduplication-haddock
  • wip/fendor/ghc-iface-type-haddock
  • wip/T23764a
  • wip/torsten.schmits/modlocation-ospath
  • wip/ghc-9.10
  • wip/fendor/ghc-iface-refact
  • wip/haddock-T1628
  • wip/soulomoon/update-hieAst-add-module-name#24493
  • haddock-2.29.1-release
  • haddock-api-2.29.1-release
  • haddock-2.29.0-release
  • haddock-api-2.29.0-release
  • haddock-2.28.0-release
  • haddock-api-2.28.0-release
  • haddock-library-1.11.0-release
  • haddock-2.27.0-release
  • haddock-api-2.27.0-release
  • haddock-2.26.0-release
  • haddock-api-2.26.0-release
  • haddock-2.24.2-release
  • haddock-api-2.24.2-release
  • haddock-2.25.0-release
  • haddock-api-2.25.0-release
  • haddock-library-1.10.0-release
  • haddock-2.23.1-release
  • haddock-2.24.0-release
  • haddock-2.23.0-release
  • haddock-2.22.0-release
40 results
Compare
sheaf's avatar
Avoid incomplete record update in Haddock Hoogle
sheaf authored 
This commit avoids running into an incomplete record update warning
in the Hoogle backend of Haddock.

This was only noticed now, because incomplete record updates were broken
in GHC 9.6. Now that they are fixed, we have to avoid running into them!
efeef9ad
History
sheaf's avatar efeef9ad
History
Name Last commit Last update
.github
doc
driver
haddock-api
haddock-library
haddock-test
hoogle-test
html-test
hypsrc-test
latex-test
.gitignore
.hlint.yaml
CHANGES.md
CODE_OF_CONDUCT.md
CONTRIBUTING.md
LICENSE
Makefile
README.md
Setup.lhs
cabal.project
ghc.mk
haddock.cabal
haddock.wrapper
README.md

Haddock CI Hackage

Haddock is the standard tool for generating documentation from Haskell code. Full documentation about Haddock itself can be found in the doc/ subdirectory, in reStructuredText format.

Project overview

This project consists of three packages:

  • haddock: provides the haddock executable. It is implemented as a tiny wrapper around haddock-api's Documentation.Haddock.haddock function.

  • haddock-api: contains the program logic of the haddock tool. The haddocks for the Documentation.Haddock module offer a good overview of the functionality.

  • haddock-library: is concerned with the parsing and processing of the Haddock markup language. Unlike the other packages, it is expected to build on a fairly wide range of GHC versions.

Contributing

See CONTRIBUTING.md to see how to make contributions to the project.