Haddock with an org backend (haddorg). https://g.ypei.me/haddock.git/atom?h=ghc-gitlab-ghc-9.2.2 2021-02-07T15:13:04+00:00 2021-02-07T15:13:04+00:00 Iñaki García Etxebarria git@inaki.blueleaf.cc 2019-07-31T15:28:00+00:00 urn:sha1:c31c156422785751e33c9a7a4f021ac8da77d364 Support a markdown-style way of annotating module references. For instance -- | [label]("Module.Name#anchor") will create a link that points to the same place as the module reference "Module.Name#anchor" but the text displayed on the link will be "label". 2020-12-08T21:06:02+00:00 alexbiehl alexbiehl@gmail.com 2020-12-08T20:00:50+00:00 urn:sha1:c4291bfc06211c9f60c9d43b4ada5c75ab8b41f8 2020-12-08T15:43:05+00:00 Xia Li-yao Lysxia@users.noreply.github.com 2020-12-08T15:43:05+00:00 urn:sha1:7240b69e3444e40546c7a17855eed2e5ab8a0816 * Fix multiple typos and inconsistencies in doc/markup.rst Note: I noticed some overlap with #1112 from @wygulmage and #1081 from @parsonsmatt after creating these proposed changes - mea culpa for not looking at the open PRs sooner. * Fix #1113 If no Signatures, no section of index.html * Change the formatting of missing link destinations The current formatting of the missing link destination does not really help user to understand the reasons of the missing link. To address this, I've changed the formatting in two ways: - the missing link symbol name is now fully qualified. This way you immediately know which haskell module cannot be linked. It is then easier to understand why this module does not have documentation (hidden module or broken documentation). - one line per missing link, that's more readable now that symbol name can be longer due to qualification. For example, before haddock was listing missing symbol such as: ``` could not find link destinations for: Word8 Word16 mapMaybe ``` Now it is listed as: ``` could not find link destinations for: - Data.Word.Word8 - Data.Word.Word16 - Data.Maybe.mapMaybe ``` * Add `--ignore-link-symbol` command line argument This argument can be used multiples time. A missing link to a symbol listed by `--ignore-link-symbol` won't trigger "missing link" warning. * Forbid spaces in anchors (#1148) * Improve error messages with context information (#1060) Co-authored-by: Matt Audesse <matt@mattaudesse.com> Co-authored-by: Mike Pilgrem <mpilgrem@users.noreply.github.com> Co-authored-by: Guillaume Bouchard <guillaume.bouchard@tweag.io> Co-authored-by: Pepe Iborra <pepeiborra@gmail.com> 2020-12-08T15:42:17+00:00 Xia Li-yao Lysxia@users.noreply.github.com 2020-12-08T15:42:17+00:00 urn:sha1:1bedd20b94359728c25f64f7643a0ca0fb0f9fa2 2020-03-28T00:34:33+00:00 Alec Theriault alec.theriault@gmail.com 2020-03-28T00:16:51+00:00 urn:sha1:b0514cc5d53bb37424177d2ba986216a914f8b1c Our quickcheck tests for `haddock-library` stumbled across an edge case input that was causing Haddock to crash: it was a unicode space character. The root cause of the crash is that we were implicitly assuming that if a space character was not " \t\f\v\r", it would have to be "\n". We fix this by instead defining horizontal space as: any space character that is not '\n'. Fixes #1142 2019-02-25T08:42:46+00:00 Alec Theriault alec.theriault@gmail.com 2019-02-06T09:01:41+00:00 urn:sha1:a5199600c39d25d7b71dcb2328000c1c49ad95a2 * '(<|>)' and '`elem`' now get parsed and rendered properly as links * 'DbModule'/'DbUnitId' now properly get split apart into two links * tuple names now get parsed properly * some more small niceties... The identifier parsing code is more precise and more efficient (although to be fair: it is also longer and in its own module). On the rendering side, we need to pipe through information about backticks/parens/neither all the way through from renaming to the backends. In terms of impact: a total of 35 modules in the entirety of the bootlib + ghc lib docs change. The only "regression" is things like '\0'. These should be changed to @\\0@ (the path by which this previously worked seems accidental). 2019-02-25T08:42:41+00:00 Alec Theriault alec.theriault@gmail.com 2018-07-19T18:42:26+00:00 urn:sha1:dd47029cb29c80b1ab4db520c9c2ce4dca37f833 Identifier links can be prefixed with a 'v' or 't' to indicate the value or type namespace of the desired identifier. For example: -- | Some link to a value: v'Data.Functor.Identity' -- -- Some link to a type: t'Data.Functor.Identity' The default is still the type (with a warning about the ambiguity) 2019-02-03T17:11:05+00:00 Alec Theriault alec.theriault@gmail.com 2019-01-31T23:37:58+00:00 urn:sha1:a0973d09a5b4f6a08b35c0b3de371c895d7d847a The circumstances under which this module appeared are completely gone. The Hyperlinker backend no longer needs this module (it uses the more efficient `Encoding` module from `ghc`). Why no deprecation? Because this module really shouldn't exist! - It isn't used in `haddock-library`/`haddock-api` anymore - It was copy pasted directly from `utf8-string` - Folks seeking a boot-lib only solution can use `ghc`'s `Encoding` 2018-11-06T20:03:24+00:00 Alec Theriault alec.theriault@gmail.com 2018-07-20T07:56:03+00:00 urn:sha1:f11b26e952860f576b3321b35e572ebb339268de 2018-07-20T13:09:05+00:00 Simon Jakobi simon.jakobi@gmail.com 2018-07-20T13:06:06+00:00 urn:sha1:88aac156228f94e17b81d8bcfb961ddcde878489 * Add tests for the identifier parser * docs: Clarify how to delimit identifiers (cherry picked from commit 0861affeca4d72938f05a2eceddfae2c19199071)