aboutsummaryrefslogtreecommitdiff
Commit message (Collapse)AuthorAgeFilesLines
* Changes for GHC#17566Alex Biehl2020-12-085-6/+32
| | | | See https://gitlab.haskell.org/ghc/ghc/merge_requests/2469
* simplify calculating percentages fixing #1194 (#1236)Willem Van Onsem2020-12-081-1/+1
|
* Enable two warnings (#1245)tomjaguarpaw2020-12-088-1/+10
| | | | | because they will be soon be added to -Wall. See https://gitlab.haskell.org/ghc/ghc/-/issues/15656
* Add dangling changes from branches ghc-8.6 and ghc-8.8 (#1243)Xia Li-yao2020-12-0810-57/+111
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * 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
|
* Bump bl from 1.2.2 to 1.2.3 in /haddock-api/resources/html (#1255)dependabot[bot]2020-12-081-4/+4
| | | | | | | | | Bumps [bl](https://github.com/rvagg/bl) from 1.2.2 to 1.2.3. - [Release notes](https://github.com/rvagg/bl/releases) - [Commits](https://github.com/rvagg/bl/compare/v1.2.2...v1.2.3) Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
* Allow scrolling search results (#1235)Maximilian Tagher2020-12-081-0/+2
| | | Closes https://github.com/haskell/haddock/issues/1231
* Use gender neutral word in docs (#1260)Veronika Romashkina2020-12-081-8/+8
|
* Fix docs links from Darcs to GitHub in intro (#1262)Veronika Romashkina2020-12-081-4/+2
|
* Another round of `npm audit fix` (#1228)Alexander Biehl2020-08-191-9/+9
| | | | | | | | | This should shut down the warnings on Github. Note that the security issues seem to have been entirely in the build dependencies, since the output JS has not changed. Last NPM dependency audit happend in d576b2327e2bc117f912fe0a9d595e9ae62614e0 Co-authored-by: Alex Biehl <alex.biehl@target.com>
* Use floor over round to calculate the percentage (#1195)Willem Van Onsem2020-05-251-1/+1
| | | | | | If we compile documentation where only a small fraction is undocumented, it is misleading to see 100% coverage - 99% is more intuitive. Fixes #1194
* Add support for custom section anchors (#1179)Iñaki2020-04-254-1/+121
| | | | | | | | | | | | This allows to have stable anchors for groups, even if the set of groups in the documentation is altered. The syntax for setting the anchor of a group is -- * Group name #desiredAnchor# Which will produce an html anchor of the form '#g:desiredAnchor' Co-authored-by: Iñaki García Etxebarria <git@inaki.blueleaf.cc>
* Fallback to `hiDecl` when `extractDecl` failsAlec Theriault2020-04-215-45/+280
| | | | | | | | | | | | Sometimes, the declaration being exported is a subdecl (for instance, a record accessor getting exported at the top-level). For these cases, Haddock has to find a way to produce some synthetic sensible top-level declaration. This is done with `extractDecl`. As is shown by #1067, this is sometimes impossible to do just at a syntactic level (for instance when the subdecl is re-exported). In these cases, the only sensible thing to do is to try to reify a declaration based on a GHC `TyThing` via `hiDecl`.
* Don't warn about missing links in miminal sigsAlec Theriault2020-04-152-4/+17
| | | | | | | | | | | When renaming the Haddock interface, never emit warnings when renaming a minimal signature. Also added some documention around `renameInterface`. Minimal signatures intentionally include references to potentially un-exported methods (see the discussion in #330), so it is expected that they will not always have a link destination. On the principle that warnings should always be resolvable, this shouldn't produce a warning. See #1070.
* Prune docstrings that are never renderedAlec Theriault2020-04-151-2/+15
| | | | | | | | | | | | | | | | | | | When first creating a Haddock interface, trim `ifaceDocMap` and `ifaceArgMap` to not include docstrings that can never appear in the final output. Besides checking with GHC which names are exported, we also need to keep all the docs attached to instance declarations (it is much tougher to detect when an instance is fully private). This change means: * slightly smaller interface files (7% reduction on boot libs) * slightly less work to do processing docstrings that aren't used * no warnings in Haddock's output about private docstrings (see #1070) I've tested manually that this does not affect any of the boot library generated docs (the only change in output was some small re-ordering in a handful of instance lists). This should mean no docstrings have been incorrectly dropped.
* Recode Doc to Json. (#1159)Ignat Insarov2020-04-091-5/+162
| | | | | * Recode Doc to Json. * More descriptive field labels.
* Fix #1050 by filtering out invisible AppTy argumentsRyan Scott2020-04-053-5/+129
| | | | | | | | | | | | This makes the `synifyType` case for `AppTy` more intelligent by taking into consideration the visibilities of each `AppTy` argument and filtering out any invisible arguments, as they aren't intended to be displayed in the source code. (See #1050 for an example of what can happen if you fail to filter these out.) Along the way, I noticed that a special `synifyType` case for `AppTy t1 (CoercionTy {})` could be consolidated with the case below it, so I took the opportunity to tidy this up.
* Allow QuickCheck 2.14Felix Yan2020-04-011-1/+1
| | | Builds fine and all tests pass.
* Disallow links in section headersAlec Theriault2020-03-284-54/+19
| | | | | | | | | | | | | This is quite straightforward to implement, since we already had a function `docToHtmlNoAnchors` (which we used to generate the link in the sidebar "Contents"). This breaks test `Bug387`, but that test case has aged badly: we now automatically generate anchors for all headings, so manually adding an anchor in a section makes no sense. Nested anchors are, as pointed out in #1054, disallowed by the HTML standard. Fixes #1054
* `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-285-8/+12
| | | | | | | | * 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)
* Use `unLoc`/`noLoc` from GHC instead of `unL`/`reL`Alec Theriault2020-03-285-57/+44
| | | | | | | | * `unL` is already defined by GHC as `unLoc` * `reL` is already defined by GHC as `noLoc` (in a safer way too!) * Condense `setOutputDir` and add a about exporting from GHC Fixes #978
* Use TTG empty extensions to remove some `error`'sAlec Theriault2020-03-286-26/+21
| | | | | | | | | | | None of these error cases should ever have been reachable, so this is just a matter of leveraging the type system to assert this. * Use the `NoExtCon` and `noExtCon` to handle case matches for no extension constructors, instead of throwing an `error`. * Use the extension field of `HsSpliceTy` to ensure that this variant of `HsType` cannot exist in an `HsType DocNameI`.
* Remove unused `Haddock.Utils` functionsAlec Theriault2020-03-286-147/+102
| | | | | | | * removed functions in `Haddock.Utils` that were not used anywhere (or exported from the `haddock-api` package) * moved GHC-specific utils from `Haddock.Utils` to `Haddock.GhcUtils`
* Disallow qualified uses of reserved identifiersAlec Theriault2020-03-273-12/+103
| | | | | | | | | This a GHC bug (https://gitlab.haskell.org/ghc/ghc/issues/14109) too, but it is a relatively easy fix in Haddock. Note that the fix must live in `haddock-api` instead of `haddock-library` because we can only really decide if an identifier is a reserved one by asking the GHC lexer. Fixes #952
* 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 READMEAlec Theriault2020-03-261-57/+48
| | | | | | | | | | Removed some out of date links/info, added some more useful links. * badge to Hackage * update old trac link * `ghc-head` => `ghc-8.10` * `cabal new-*` is now `cabal v2-*` and it should Just Work * `--test-option='--accept'` is the way to accept testsuite output
* Update `.travis.yml` to work with GHC 8.10.1Alec Theriault2020-03-264-45/+78
| | | | | | * Regenerated the Travis file with `haskell-ci` * Beef up `.cabal` files with more `tested-with` information
* Tentative 2.24 releaseAlec Theriault2020-03-227-9/+18
| | | | | Adjusted changelogs and versions in `.cabal` files in preparation for the upcoming release bundled with GHC 8.10.
* Fix NPM security warningsAlec Theriault2020-03-221-163/+182
| | | | | | This was done by calling `npm audit fix`. Note that the security issues seem to have been entirely in the build dependencies, since the output JS has not changed.
* Clean up warningsAlec Theriault2020-03-2214-35/+22
| | | | | | * 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-2010-146/+150
| | | | | | | | | | * 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-20230-1535/+8324
|\
| * Update test fixturesKleidukos2020-03-192-6/+6
| |
| * Force ghc-8.8.3Kleidukos2020-03-191-2/+2
| |
| * Replace the 'caption' class so that the collapsible sections are shownKleidukos2020-03-191-1/+1
| |
| * 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.
| * Changes from #14579Ryan Scott2019-11-031-22/+5
| | | | | | | | | | | | | | We now have a top-level `tyConAppNeedsKindSig` function, which means that we can delete lots of code in `Convert`. (cherry picked from commit cfd682c5fd03b099a3d78c44f9279faf56a0ac70)
| * Reify oversaturated data family instances correctly (#1103)Ryan Scott2019-10-233-15/+603
| | | | | | | | | | | | This fixes #1103 by adapting the corresponding patch for GHC (see https://gitlab.haskell.org/ghc/ghc/issues/17296 and https://gitlab.haskell.org/ghc/ghc/merge_requests/1877).
| * Add Hyperlinker test cases for TH-related stuffAlec Theriault2019-10-079-0/+1489
| | | | | | | | | | Hopefully this will guard against regressions around quasiquotes, TH quotes, and TH splices.
| * Add a regression test for #1091Alec Theriault2019-10-075-0/+49
| | | | | | | | Previously, this input would crash Haddock.
| * Prefer un-hyperlinked sources to no sourcesAlec Theriault2019-10-072-14/+26
| | | | | | | | | | | | It is possible to fail to extract an HIE ast. This is however not a reason to produce _no_ output - we should still make a colorized HTML page.
| * Fix crash when there are no srcspans in the file due to CPPZubin Duggal2019-10-072-9/+12
| |
| * Fix the ignore-exports option (#1082)Alexis King2019-09-304-18/+56
| | | | | | The `ignore-exports` option has been broken since #688, as mentioned in https://github.com/haskell/haddock/pull/766#issue-172505043. This PR fixes it.
| * Fix Travis CI, loosen .cabal bounds (#1089)Alec Theriault2019-09-204-102/+135
| | | | | | | | | | | | | | 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
| * update for new way to store hiefile headersZubin Duggal2019-06-041-2/+3
| |
| * Release haddock-2.23, haddock-library-1.8.0Alec Theriault2019-05-266-17/+18
| | | | | | | | | | Tentatively adjust bounds and changelogs for the release to be bundled with GHC 8.8.1.
| * Merge branch 'ghc-8.6' into ghc-8.8Alec Theriault2019-05-260-0/+0
| |\
| | * Comment C, which clarifies why e.g. ReadP is not enoughOleg Grenrus2019-05-051-0/+7
| | |
generated by cgit v1.2.3 (git 2.39.1) at 2024-09-21 20:40:31 +0000