Skip to content

Docs: haddock-hyperlink-source no longer uses HsColour - #12419

Open
SatvikMishra08 wants to merge 1 commit into
haskell:masterfrom
SatvikMishra08:haddock-hyperlink-source-hscolour
Open

SatvikMishra08 wants to merge 1 commit into
haskell:masterfrom
SatvikMishra08:haddock-hyperlink-source-hscolour

Conversation

@SatvikMishra08

Copy link
Copy Markdown
Contributor

Fixes #9692

The haddock-hyperlink-source docs still said the hyperlinked source is generated with HsColour. Since Haddock 2.17 it's Haddock's own --hyperlinked-source that does this, and Cabal only falls back to HsColour for older Haddock versions (using_hscolour in Distribution.Simple.Haddock). I reworded the entry to say that, noted on haddock-hscolour-css that it only applies to that fallback, and replaced the dead york.ac.uk HsColour link with the Hackage page.

Template B: This PR does not modify behaviour or interface

  • Patches conform to the coding conventions.
  • Is this a PR that fixes CI? If so, it will need to be backported to older cabal release branches (ask maintainers for directions).

Haddock 2.17+ generates hyperlinked source itself; Cabal only falls back
to HsColour for older Haddock versions. Also update the dead HsColour link.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

--haddock-hyperlink-source incorrectly references HsColour

1 participant