aboutsummaryrefslogtreecommitdiff
path: root/haddock-library
Commit message (Collapse)AuthorAgeFilesLines
* Add support for labeled module referencesIñaki García Etxebarria2021-02-075-28/+131
| | | | | | | | | | 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".
* Merge remote-tracking branch 'origin/ghc-8.10' into ghc-9.0Ben Gamari2021-01-0522-207/+498
|\
| * Fix haddock-library testsalexbiehl2020-12-081-1/+1
| |
| * Add dangling changes from branches ghc-8.6 and ghc-8.8 (#1243)Xia Li-yao2020-12-083-4/+9
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * 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>
| * Allow more characters in anchor following module reference (#1220)Xia Li-yao2020-12-082-2/+11
| |
| * Allow QuickCheck 2.14Felix Yan2020-04-011-1/+1
| | | | | | Builds fine and all tests pass.
| * `haddock-library` document header levelAlec Theriault2020-03-282-5/+5
| | | | | | | | | | Document the fact the header level is going to always be between 1 and 6 inclusive. Along the way, I also optimized the parsing code a bit.
| * Cleanup up GHC flags in `.cabal` filesAlec Theriault2020-03-281-1/+1
| | | | | | | | | | | | | | | | * enable more useful warning flags in `haddock-api`, handle the new warnings generated * remove `-fwarn-tabs` (now we'd use `-Wtabs`, but this has been in `-Wall` for a while now)
| * Fix crash in `haddock-library` on unicode spaceAlec Theriault2020-03-272-8/+14
| | | | | | | | | | | | | | | | | | | | | | | | | | 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
| * Update `.travis.yml` to work with GHC 8.10.1Alec Theriault2020-03-261-1/+12
| | | | | | | | | | | | * Regenerated the Travis file with `haskell-ci` * Beef up `.cabal` files with more `tested-with` information
| * Tentative 2.24 releaseAlec Theriault2020-03-222-2/+4
| | | | | | | | | | Adjusted changelogs and versions in `.cabal` files in preparation for the upcoming release bundled with GHC 8.10.
| * Clean up warningsAlec Theriault2020-03-221-14/+12
| | | | | | | | | | | | * unused imports * imports of `Data.List` without import lists * missing `CompatPrelude` file in `.cabal`
| * Update parsing to strip whitespace from table cells (#1074)Alina Banerjee2020-03-209-98/+102
| | | | | | | | | | | | | | | | | | | | * Update parsing to strip leading & trailing whitespace from table cells * Update fixture data to disallow whitespaces at both ends in table cells * Add test case for whitespaces stripped from both ends of table cells * Update table reference test data for html tests
| * Merge branch 'ghc-8.8' into ghc-8.10Alec Theriault2020-03-2013-75/+332
| |\
| | * Fix build-failure regression for base < 4.7Herbert Valerio Riedel2019-12-086-30/+61
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The `$>` operator definition is available only since base-4.7 which unfortunately wasn't caught before release to Hackage (but has been fixed up by a metadata-revision) This commit introduces a `CompatPrelude` module which allows to reduce the amount of CPP by ousting it to a central location, i.e. the new `CompatPrelude` module. This pattern also tends to reduce the tricks needed to silence unused import warnings. Addresses #1119
| | * Document error-prone conditional definition of instancesHerbert Valerio Riedel2019-12-081-0/+6
| | | | | | | | | | | | | | | | | | | | | | | | | | | This can easily trip up people if one isn't aware of it. Usually it's better to avoid this kind of conditionality especially for typeclasses for which there's an compat-package as conditional instances like these tend to fragment the ecosystem into those packages that go the extra mile to provide backward compat via those compat-packages and those that fail to do so.
| | * Fix Travis CI, loosen .cabal bounds (#1089)Alec Theriault2019-09-201-7/+9
| | | | | | | | | | | | | | | | | | | | | Tentatively for the 2.23 release: * updated Travis CI to work again * tweaked bounds in the `.cabal` files * adjusted `extra-source-files` to properly identify test files
| | * Release haddock-2.23, haddock-library-1.8.0Alec Theriault2019-05-262-6/+6
| | | | | | | | | | | | | | | Tentatively adjust bounds and changelogs for the release to be bundled with GHC 8.8.1.
| | * Remove outdated `.ghci` files and `scripts`Alec Theriault2019-05-131-1/+0
| | | | | | | | | | | | | | | The `.ghci` files are actively annoying when trying to `cabal v2-repl`. As for the `scripts`, the distribution workflow is completely different.
| | * Merge branch 'ghc-8.6' into ghc-8.8Alec Theriault2019-03-035-4/+50
| | |\
| | | * Make a fixture of weird parsing of lists (#997)Oleg Grenrus2019-02-045-1/+47
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The second example is interesting. If there's a list directly after the header, and that list has deeper structure, the parser is confused: It finds two lists: - One with the first nested element, - everything after it I'm not trying to fix this, as I'm not even sure this is a bug, and not a feature.
| | | * Loosen 'QuickCheck' and 'hspec' boundsAlec Theriault2019-01-281-2/+2
| | | | | | | | | | | | | | | | | | | | It looks like the new versions don't cause any breakage and loosening the bounds helps deps fit in one stack resolver.
| | * | Better identifier parsingAlec Theriault2019-02-255-61/+212
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * '(<|>)' 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).
| | * | Support value/type namespaces on identifier linksAlec Theriault2019-02-253-8/+30
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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)
* | | | haddock: Bounds bumps for GHC 8.12Ben Gamari2020-06-131-2/+2
| | | |
* | | | Noramlize `tested-with` fields in cabal filesJohn Ericson2020-02-101-0/+2
| | | |
* | | | Version bumps for GHC 8.11Ben Gamari2019-11-141-1/+1
|/ / /
* | | Merge pull request #1014 from hvr/pr/bsd2-normaliseSimon Marlow2019-02-061-18/+21
|\ \ \ | |/ / |/| | Normalise LICENSE text w/ cabal's BSD2 template
| * | Normalise LICENSE text w/ cabal's BSD2 templateHerbert Valerio Riedel2019-02-021-18/+21
| | | | | | | | | | | | | | | Also, correct the `.cabal` files to advertise `BSD2` instead of the incorrect `BSD3` license.
* | | Remove `Documentation.Haddock.Utf8`Alec Theriault2019-02-034-93/+5
|/ / | | | | | | | | | | | | | | | | | | | | | | 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`
* | Update/modernise haddock-library.cabal fileHerbert Valerio Riedel2019-02-021-40/+45
| |
* | Fix warnings, accept outputAlec Theriault2018-12-122-2/+2
| | | | | | | | | | | | | | * remove redundant imports (only brought to light due to recent work for improving redundant import detection) * fix a bug that was casuing exports to appear in reverse order * fix something in haddock-library that prevented compilation on old GHC's
* | Bump version boundsAlec Theriault2018-11-061-0/+4
| |
* | Fix/add to haddock-library test suiteAlec Theriault2018-11-067-6/+20
| |
* | Accept test caseAlec Theriault2018-11-061-1/+1
| |
* | Support (and flatten) inline markup in image linksAlec Theriault2018-11-062-5/+44
| | | | | | | | | | | | | | Inline markup is supported in image links but, as per the [commonmark recommendation][0], it is stripped back to a plain text representation. [0]: https://spec.commonmark.org/0.28/#example-547
* | Support hyperlink labels with inline markupAlec Theriault2018-11-063-41/+43
| | | | | | | | The parser for pictures hasn't been properly adjusted yet.
* | Faster 'Text' driven parser combinatorsAlec Theriault2018-11-053-35/+83
|/ | | | | | | | Perf only change: * use 'getParserState'/'setParserState' to make 'Text'-optimized parser combinators * minimize uses of 'Data.Text.{pack,unpack,cons,snoc}'
* Bump haddock-library to 1.7.0Alec Theriault2018-10-162-3/+7
| | | | | | The 1.6.1 release should've been a major bump, since types in the `Documentation.Haddock.Parser.Monad` module changed. This version makes that module internal (as it morally should be).
* Minor tweak to package descriptionHerbert Valerio Riedel2018-10-161-2/+2
|
* Build on 7.4 and 7.8Alec Theriault2018-10-161-1/+2
|
* Turn haddock-library into a minor releaseAlec Theriault2018-09-222-4/+5
| | | | Fix some version bounds in haddock-library too.
* Bump haddock-api-2.21.0, haddock-library-1.7.0Alec Theriault2018-09-222-2/+6
| | | | | | * Update CHANGELOGS * Update new versions in Cabal files * Purge references to ghc-8.4/master branches in README
* Update the ghc-8.6 branch (#889)Simon Jakobi2018-07-201-1/+47
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Revert "Bump GHC version to 8.6" This was applied to the wrong branch; there's now a `ghc-8.6` branch; ghc-head is always supposed to point to GHC HEAD, i.e. an odd major version. The next version bump to `ghc-head` is supposed to go from e.g. 8.5 to 8.7 This reverts commit 5e3cf5d8868323079ff5494a8225b0467404a5d1. * README updates (#856) * README: Remove mentions of master branch * README: Add instructions for using html-test * README: Change command to run _all_ the testsuites * README: Add project overview section (cherry picked from commit 61d6f935da97eb96685f07bf385102c2dbc2a33c) * Export more fixities for Hoogle (#871) This exports fixities for more things, including class methods and type-level operators. (cherry picked from commit 88316b972e3d47197b1019111bae0f7f87275fce) * Avoid line breaks due to line length in Hoogle (#868) * Avoid line breaks due to line length in Hoogle Hoogle operates in a line-oriented fashion, so we should avoid ever breaking due to long lines. One way of doing this non-intrusively is to modify the 'DynFlags' that are threaded through the 'Hoogle' module (note this is anyways only passed through for use in the various 'showSDoc' functions). * Amend test case (cherry picked from commit 657b1b3d519545f8d4ca048c06210d6cbf0f0da0) * tyThingToLHsDecl: Preserve type synonyms that contain a forall (#880) * tyThingToLHsDecls: Preserve type synonyms that contain a forall Fixes #879. * Add Note [Invariant: Never expand type synonyms] * Clarify Note [Invariant: Never expand type synonyms] (cherry picked from commit c3eb3f0581f69e816f9453b1747a9f2a3ba02bb9) * Fix HEAD html-test (#860) * Update tests for 'StarIsType' * Accept tests * Revert "Update tests for 'StarIsType'" This reverts commit 7f0c01383bbba6dc5af554ee82988d2cf44e407a. * Refactor handling of parens in types (#874) * Fix type parenthesization in Hoogle backend Ported the logic in the HTML and LaTeX backends for adding in parens into something top-level in 'GhcUtil'. Calling that from the Hoogle backend fixes #873. * Remove parenthesizing logic from LaTeX and XHTML backends Now, the only times that parenthesis in types are added in any backend is through the explicit 'HsParTy' constructor. Precedence is also represented as its own datatype. * List out cases explicitly vs. catch-all * Fix printing of parens for QuantifiedConstraints The priority of printing 'forall' types was just one too high. Fixes #877. * Accept HTML output for quantified contexts test * Preserve docs on type family instances (#867) * Preserve docs on type family instances The only problem was that the instance location was slightly off for type family instances. * Accept output (cherry picked from commit 133e9c2c168db19c1135479f7ab144c4e33af2a4) * Fix broken instance source links (#869) The problem manifests itself in instances that are defined in modules other than the module where the class is defined. The fix is just to thread through the 'Module' of the instance further along. Since orphan instances appear to already have been working, I didn't do anything there. (cherry picked from commit 2de7c2acf9b1ec85b09027a8bb58bf8512e91c05) * Add some more unicode related tests (#872) This has been fixed for sure ever since we switched from attoparsec to parsec. Parts of it may have been working before that, but there was a point where this would have failed (see #191). A regression test never hurt anyone. :) (cherry picked from commit 5ec7715d418bfac0f26aec6039792a99a6e89370) * Misc tests (#858) * More tests * spliced types * constructor/pattern argument docs * strictness marks on fields with argument docs * latex test cases need seperate directory * Accept tests * Additional tests for the identifier parser (#816) * Add tests for the identifier parser * docs: Clarify how to delimit identifiers (cherry picked from commit 0861affeca4d72938f05a2eceddfae2c19199071)
* haddock-library: Bump bounds for containersSimon Jakobi2018-07-191-2/+2
|
* Bump a few dependency bounds (#845)Simon Jakobi2018-06-131-4/+4
|
* Add docs for some DocH constructors (#814)Simon Jakobi2018-06-131-0/+3
|
* Merge branch 'ghc-head' with 'ghc-8.4'Herbert Valerio Riedel2018-05-011-1/+1
|\
| * Bump upper bound on base to < 4.13Ryan Scott2018-04-191-2/+2
| | | | | | | | See https://ghc.haskell.org/trac/ghc/ticket/15018.
* | Replace 'attoparsec' with 'parsec' (#799)Alec Theriault2018-04-2516-2783/+358
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Remove attoparsec with parsec and start fixing failed parses * Make tests pass * Fix encoding issues The Haddock parser no longer needs to worry about bytestrings. All the internal parsing work in haddock-library happens over 'Text'. * Remove attoparsec vendor * Fix stuff broken in 'attoparsec' -> 'parsec' * hyperlinks * codeblocks * examples Pretty much all issues are due to attoparsec's backtracking failure behaviour vs. parsec's non-backtracking failure behaviour. * Fix small TODOs * Missing quote + Haddocks * Better handle spaces before/after paragraphs * Address review comments
generated by cgit v1.2.3 (git 2.39.1) at 2024-11-14 20:08:21 +0000