aboutsummaryrefslogtreecommitdiff
path: root/haddock-api
Commit message (Collapse)AuthorAgeFilesLines
...
| | * Increase contrast of Linuwal theme (#1037)gbaz2019-03-011-4/+6
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This is to address the concern that, on less nice and older screens, some of the shades of grey blend in too easily with the white background. * darken the font slightly * darken slightly the grey behind type signatures and such * add a border and round the corners on code blocks * knock the font down by one point
| | * `--show-interface` should output to stdout. (#1040)Alec Theriault2019-02-281-1/+2
| | | | | | | | | Fixes #864.
| | * Menu item controlling which instances are expanded/collapsed (#1007)Xia Li-yao2019-02-278-229/+635
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Adds a menu item (like "Quick Jump") for options related to displaying instances. This provides functionality for: * expanding/collapsing all instances on the currently opened page * controlling whether instances are expanded/collapsed by default * controlling whether the state of instances should be "remembered" This new functionality is implemented in Typescript in `details-helper`. The built-in-themes style switcher also got a revamp so that all three of QuickJump, the style switcher, and instance preferences now have the same style and implementation structure. See also: https://mail.haskell.org/pipermail/haskell-cafe/2019-January/130495.html Fixes #698. Co-authored-by: Lysxia <lysxia@gmail.com> Co-authored-by: Nathan Collins <conathan@galois.com>
| | * Fix standalone deriving docsAlec Theriault2019-02-251-2/+2
| | | | | | | | | | | | | | | | | | | | | | | | Docs on standalone deriving decls for classes with associated types should be associated with the class instance, not the associated type instance. Fixes #1033
| | * Loosen 'QuickCheck' and 'hspec' boundsAlec Theriault2019-01-281-3/+3
| | | | | | | | | | | | | | | It looks like the new versions don't cause any breakage and loosening the bounds helps deps fit in one stack resolver.
| | * Fix #1004 with a pinch of dropForAllsRyan Scott2019-01-271-1/+1
| | |
| | * Keep forall on H98 existential data constructors (#1003)Alec Theriault2019-01-232-3/+3
| | | | | | | | | | | | | | | | | | | | | The information about whether or not there is a source-level `forall` is already available on a `ConDecl` (as `con_forall`), so we should use it instead of always assuming `False`! Fixes #1002.
| | * Print kinded tyvars in constructors for Hoogle (#993)Alec Theriault2019-01-071-2/+8
| | | | | | | | | Fixes #992
| | * Load plugins when compiling each module (#983)Alec Theriault2018-12-202-6/+9
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * WIP: Load (typechecker) plugins from language pragmas * Revert "Load plugins when starting a GHC session (#905)" This reverts commit 72d82e52f2a6225686d9668790ac33c1d1743193. * Simplify plugin initialization code
| | * More uniform handling of `forall`'s in HTML/LaTeXAlec Theriault2018-11-262-60/+50
| | | | | | | | | | | | | | | | | | | | | * don't forget to print explicit `forall`'s when there are arg docs * when printing an explicit `forall`, print all tyvars Fixes #973
| | * Add blockquote stylingAlec Theriault2018-11-121-0/+7
| | | | | | | | | | | | | | | | | | Matches b71da1feabf33efbbc517ac376bb690b5a604c2f from hackage-server. Fixes #967.
| | * Rename 'NewOcean' theme to 'Linuwial'Alec Theriault2018-11-114-3/+3
| | |
| * | Fix bogus identifier defaultingAlec Theriault2019-02-261-9/+5
| | | | | | | | | | | | | | | | | | | | | | | | This avoids a situation in which an identifier would get defaulted to a completely different identifier. Prior to this commit, the 'Bug1035' test case would hyperlink 'Foo' into 'Bar'! Fixes #1035.
| * | Better identifier parsingAlec Theriault2019-02-2511-66/+142
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * '(<|>)' 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-255-22/+58
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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)
* | | Bump to GHC 8.10Ben Gamari2019-11-101-1/+1
| | |
* | | Define `XRec` for location information and get rid of `HasSrcSpan`Sebastian Graf2019-11-011-16/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | In https://gitlab.haskell.org/ghc/ghc/merge_requests/1970 I propose a simpler way to encode location information into the GHC and Haddock AST while incurring no cost for e.g. TH which doesn't need location information. These are just changes that have to happen in lock step.
* | | Refactor for OutputableBndrId changesSebastian Graf2019-10-252-4/+4
| | |
* | | Refactor for withTiming changes.Andreas Klebinger2019-10-212-9/+9
| | |
* | | Remove spaces around @-patterns (#1093)Vladislav Zavialov2019-09-282-3/+3
| | | | | | | | | This is needed to compile `haddock` when [GHC Proposal #229](https://github.com/ghc-proposals/ghc-proposals/blob/master/proposals/0229-whitespace-bang-patterns.rst) is implemented.
* | | Small change in to facilitate extended typed-holes (#1090)Matthías Páll Gissurarson2019-09-281-4/+4
| | | | | | | | | This change has no functional effect on haddock itself, it just changes one pattern to use `_ (` rather than `_(`, so that we may use `_(` as a token for extended typed-holes later.
* | | Fix for GHC module renamingSylvain Henry2019-09-121-1/+1
| | |
* | | Changes for #15247Ryan Scott2019-07-0310-321/+347
| | |
* | | update for new way to store hiefile headersZubin Duggal2019-05-301-2/+3
| | |
* | | Match changes with #14332Ryan Scott2019-05-221-3/+15
| | |
* | | Changes for #16110/#16356Ryan Scott2019-05-144-37/+19
| | |
* | | Match changes for "Stop inferring over-polymorphic kinds"Alec Theriault2019-03-092-8/+3
| | | | | | | | | | | | | | | | | | | | | | | | The `hsq_ext` field of `HsQTvs` is now just the implicit variables (instead of also including information about which of these variables are dependent). This commit shouldn't change any functionality in Haddock.
* | | Remove reference to Opt_SplitObjs flagBen Gamari2019-03-041-2/+1
| | | | | | | | | | | | Split-objects has been removed.
* | | Visible dependent quantification (#16326) changesRyan Scott2019-02-279-51/+80
| | |
* | | Match GHC changes for T16185Alec Theriault2019-02-224-19/+17
| | | | | | | | | | | | | | | | | | | | | `FunTy` now has an `AnonArgFlag` that indicates whether the arrow is a `t1 => t2` or `t1 -> t2`. This commit shouldn't change any functionality in Haddock.
* | | Bump ghc version to 8.9Ryan Scott2019-02-182-3/+3
| | |
* | | Parser changes to match !380Vladislav Zavialov2019-02-171-6/+9
| | |
* | | Fix tests broken by GHCAlec Theriault2019-02-162-4/+4
| | | | | | | | | | | | | | | | | | | | | | | | Changes in 19626218566ea709b5f6f287d3c296b0c4021de2 affected some of the hyperlinker output. Accepted the new output (hovering over a `..` now shows you what that wildcard binds). Also fixed some stray deprecation warnings.
* | | Clean up logic for guessing `-B` and `--lib` (#1026)Alec Theriault2019-02-132-77/+72
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Haddock built with the `in-ghc-tree` flag tries harder to find the GHC lib folder and its own resources. This should make it possible to use `in-ghc-tree`-built Haddock without having to specify the `-B` and `--lib` options (just how you can use in-tree GHC without always specifying the `-B` option). The logic to do this relies on `getExecutablePath`, so we only get this auto-detection on platforms where this function works.
* | | Remove workaround for now-fixed Clang CPP bug (#1028)Alec Theriault2019-02-114-81/+21
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Before LLVM 6.0.1 (or 10.0 on Apple LLVM), there was a bug where lines that started with an octothorpe but turned out not to lex like pragmas would have an extra line added after them. Since this bug has been fixed upstream and that it doesn't have dire consequences anyways, the workaround is not really worth it anymore - we can just tell people to update their clang version (or re-structure their pragma code).
* | | Merge remote-tracking branch 'gitlab/wip/T16236-2' into ghc-headAlec Theriault2019-02-104-10/+10
|\ \ \
| * | | Matching changes in GHC for #16236Alan Zimmerman2019-02-054-10/+10
| | | |
* | | | Merge pull request #1014 from hvr/pr/bsd2-normaliseSimon Marlow2019-02-062-19/+22
|\ \ \ \ | |/ / / |/| | | Normalise LICENSE text w/ cabal's BSD2 template
| * | | Normalise LICENSE text w/ cabal's BSD2 templateHerbert Valerio Riedel2019-02-022-19/+22
| | | | | | | | | | | | | | | | | | | | Also, correct the `.cabal` files to advertise `BSD2` instead of the incorrect `BSD3` license.
* | | | Changes from #14579Ryan Scott2019-02-041-22/+5
| |/ / |/| | | | | | | | | | | We now have a top-level `tyConAppNeedsKindSig` function, which means that we can delete lots of code in `Convert`.
* | | Fix #1015 with dataConUserTyVars (#1022)Ryan Scott2019-02-041-3/+4
| | | | | | | | | | | | | | | | | | | | | The central trick in this patch is to use `dataConUserTyVars` instead of `univ_tvs ++ ex_tvs`, which displays the foralls in a GADT constructor in a way that's more faithful to how the user originally wrote it. Fixes #1015.
* | | Miscellaneous improvements to `Convert` (#1020)Alec Theriault2019-02-035-152/+444
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Now that Haddock is moving towards working entirely over `.hi` and `.hie` files, all declarations and types are going to be synthesized via the `Convert` module. In preparation for this change, here are a bunch of fixes to this module: * Add kind annotations to type variables in `forall`'s whose kind is not `Type`, unless the kind can be inferred from some later use of the variable. See `implicitForAll` and `noKindTyVars` in particular if you wish to dive into this. * Properly detect `HsQualTy` in `synifyType`. This is done by following suit with what GHC's `toIfaceTypeX` does and checking the first argument of `FunTy{} :: Type` to see if it classified as a given/wanted in the typechecker (see `isPredTy`). * Beef up the logic around figuring out when an explicit `forall` is needed. This includes: observing if any of the type variables will need kind signatures, if the inferred type variable order _without_ a forall will still match the one GHC claims, and some other small things. * Add some (not yet used) functionality for default levity polymorphic type signatures. This functionality similar to `fprint-explicit-runtime-reps`. Couple other smaller fixes only worth mentioning: * Show the family result signature only when it isn't `Type` * Fix rendering of implicit parameters in the LaTeX and Hoogle backends * Better handling of the return kind of polykinded H98 data declarations * Class decls produced by `tyThingToLHsDecl` now contain associated type defaults and default method signatures when appropriate * Filter out more `forall`'s in pattern synonyms
* | | Remove `Documentation.Haddock.Utf8`Alec Theriault2019-02-031-2/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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`
* | | Fix some Hyperlinker test suite falloutAlec Theriault2019-02-021-21/+44
|/ / | | | | | | | | | | | | | | | | | | | | * Amend `ParserSpec` to match new Hyperlinker API - pass in compiler info - strip out null tokens * Make `hypsrc-test` pass reliably - strip out `local-*` ids - strip out `line-*` ids from the `ClangCppBug` test - re-accept output
* | Use `.hie` files for the Hyperlinker backend (#977)Alec Theriault2019-01-3114-665/+771
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | # Summary This is a large architectural change to the Hyperlinker. * extract link (and now also type) information from `.hie` instead of doing ad-hoc SYB traversals of the `RenamedSource`. Also adds a superb type-on-hover feature (#715). * re-engineer the lexer to avoid needless string conversions. By going directly through GHC's `P` monad and taking bytestring slices, we avoid a ton of allocation and have better handling of position pragmas and CPP. In terms of performance, the Haddock side of things has gotten _much_ more efficient. Unfortunately, much of this is cancelled out by the increased GHC workload for generating `.hie` files. For the full set of boot libs (including `ghc`-the-library) * the sum of total time went down by 9-10% overall * the sum of total allocations went down by 6-7% # Motivation Haddock is moving towards working entirely over `.hi` and `.hie` files. This change means we no longer need the `RenamedSource` from `TypecheckedModule` (something which is _not_ in `.hi` files). # Details Along the way a bunch of things were fixed: * Cross package (and other) links are now more reliable (#496) * The lexer tries to recover from errors on every line (instead of at CPP boundaries) * `LINE`/`COLUMN` pragmas are taken into account * filter out zero length tokens before rendering * avoid recomputing the `ModuleName`-based `SrcMap` * remove the last use of `Documentation.Haddock.Utf8` (see #998) * restructure temporary folder logic for `.hi`/`.hie` model
* | Visible kind application haddock updatemynguyen2018-12-3010-24/+76
| |
* | Properly synify and render promoted type variables (#985)Alec Theriault2018-12-232-4/+6
| | | | | | | | | | | | | | | | * Synify and render properly promoted type variables Fixes #923. * Accept output
* | Refactor names + unused functions (#982)Alec Theriault2018-12-177-62/+26
| | | | | | | | | | | | | | This commit should not introduce any change in functionality! * consistently use `getOccString` to convert `Name`s to strings * compare names directly when possible (instead of comparing strings) * get rid of unused utility functions
* | Output better debug infromation on internal error in extractDeclZejun Wu2018-12-141-1/+3
| | | | | | | | This will make investigation of #979 easier
* | Fix warnings, accept outputAlec Theriault2018-12-126-8/+1
| | | | | | | | | | | | | | * 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
generated by cgit v1.2.3 (git 2.39.1) at 2024-11-23 11:14:16 +0000