aboutsummaryrefslogtreecommitdiff
Commit message (Collapse)AuthorAgeFilesLines
...
| | | * | Merge pull request #1314 from tweag/show-linear-backportHécate Moonlight2021-02-079-7/+259
| | | |\ \ | | | | | | | | | | | | Backport #1238 (linear types) to ghc-9.0
| | | | * | Display linear/multiplicity arrows correctly (#1238)Krzysztof Gogolewski2021-02-059-7/+259
| | | | |/ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Previously we were ignoring multiplicity and displayed a %1 -> b as a -> b. (cherry picked from commit b4b4d896d2d68d6c48e7db7bfe95c185ca0709cb)
| | | * | Merge pull request #1319 from alexbiehl/alex/compatHécate Moonlight2021-02-0714-49/+198
| | | |\ \ | | | | |/ | | | |/| Backward compat: Add support for labeled module references
| | | | * Add support for labeled module referencesIñaki García Etxebarria2021-02-0714-49/+198
| | | |/ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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 pull request #1313 from Kleidukos/amend-contributingHécate Moonlight2021-02-052-19/+16
| | | |\ | | | | | | | | | | Amend the CONTRIBUTING.md file
| | | | * Amend the CONTRIBUTING.md fileHécate Moonlight2021-02-052-19/+16
| | | |/
| | | * Merge pull request #1312 from Kleidukos/proper-branch-etiquetteHécate Moonlight2021-02-052-55/+65
| | | |\ | | | | | | | | | | Add a CONTRIBUTING.md file
| | | | * Add a CONTRIBUTING.md fileHécate Moonlight2021-02-052-55/+65
| | | |/
| | | * Cleanup: fix build warningsVladislav Zavialov2021-02-056-7/+7
| | | |
| | | * Merge pull request #1296 from Kleidukos/ghc-9.0Hécate Moonlight2021-02-054-33/+31
| | | |\ | | | | | | | | | | Merge the late additions to ghc-8.10 into ghc-9.0
| | | | * Update cabal.project and README build instructionsVladislav Zavialov2021-02-052-20/+13
| | | | |
| | | | * Move CI to ghc-9.0Hécate Moonlight2021-02-052-13/+18
| | | |/
| | | * Add import list to Data.ListOleg Grenrus2021-01-241-1/+1
| | | |
* | | | Merge branch 'wip/ghc-head-merge' into ghc-headBen Gamari2021-02-06262-2330/+9838
|\ \ \ \ | |/ / / |/| / / | |/ /
| * | Merge commit '41964cb2fd54b5a10f8c0f28147015b7d5ad2c02' into wip/ghc-head-mergeBen Gamari2021-02-063-0/+3
| |\ \
| * \ \ Merge commit 'a917dfd29f3103b69378138477514cbfa38558a9' into wip/ghc-head-mergeBen Gamari2021-02-060-0/+0
| |\ \ \
| * | | | Fix partial record selector warningBen Gamari2021-02-061-3/+3
| | | | |
| * | | | Merge remote-tracking branch 'origin/ghc-head' into wip/ghc-head-mergeBen Gamari2021-02-0630-670/+810
| |\ \ \ \
| * \ \ \ \ Merge remote-tracking branch 'origin/ghc-9.0' into ghc-headBen Gamari2021-01-13262-2359/+9944
| |\ \ \ \ \ | | | |_|_|/ | | |/| | |
| | * | | | Merge commit '1e56f63c3197e7ca1c1e506e083c2bad25d08793' into ghc-9.0Ben Gamari2021-01-05260-2350/+9792
| | |\ \ \ \
| | | * \ \ \ Merge remote-tracking branch 'origin/ghc-8.10' into ghc-9.0Ben Gamari2021-01-05260-2350/+9791
| | | |\ \ \ \
| | | | * \ \ \ Merge pull request #1282 from andreasabel/masterHécate Moonlight2021-01-041-0/+4
| | | | |\ \ \ \ | | | | | | | | | | | | | | | | | | Build instructions: haddock-library and -api first!
| | | | | * | | | Build instructions: haddock-library and -api first!Andreas Abel2020-12-301-0/+4
| | | | |/ / / /
| | | | * | | | Bump ini from 1.3.5 to 1.3.7 in /haddock-api/resources/html (#1269)dependabot[bot]2020-12-101-9/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Bumps [ini](https://github.com/isaacs/ini) from 1.3.5 to 1.3.7. - [Release notes](https://github.com/isaacs/ini/releases) - [Commits](https://github.com/isaacs/ini/compare/v1.3.5...v1.3.7) Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
| | | | * | | | Move to GitHub CI (#1266)Alexander Biehl2020-12-084-158/+53
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Initial version of ci.yml This is a straight copy from Dmitrii Kovanikov's blog post at https://kodimensional.dev/github-actions. Will adapt to haddock in successive commits. * Delete .travis.yml * Modify to only test on ghc-8.10.{1,2} * Use actions/setup-haskell@v1.1.4 * Relax QuickCheck bound on haddock-api * Remove stack matrix for now * Nail down to ghc-8.10 branch for now * Pin index state to 2020-12-08T20:13:44Z for now * Disable macOS and Windows tests for now for speed up
| | | | * | | | Fix haddock-library testsalexbiehl2020-12-081-1/+1
| | | | | | | |
| | | | * | | | Adapt Haddock for QualifiedDoMatthías Páll Gissurarson2020-12-081-2/+2
| | | | | | | |
| | | | * | | | Import intercalatealexbiehl2020-12-081-0/+1
| | | | | | | |
| | | | * | | | 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
generated by cgit v1.2.3 (git 2.39.1) at 2024-11-16 00:01:08 +0000