aboutsummaryrefslogtreecommitdiff
Commit message (Collapse)AuthorAgeFilesLines
* Remove unnecessary backslashes from docs (#908)Noel Bourke2018-08-211-3/+3
| | | | | | | On https://haskell-haddock.readthedocs.io/en/latest/markup.html#special-characters the backslash and backtick special characters showed up with an extra backslash before them – I think the escaping is not (or no longer) needed for those characters in rst.
* Make --package-version optional for --hoogle generation (#899)Alexander Biehl2018-08-061-3/+8
| | | | | | | | * Make --package-version optional for --hoogle generation * Import mkVersion * It's makeVersion not mkVersion
* Avoid "invalid argument (invalid character)" on non-unicode Windows (#892)Yuji Yamamoto2018-07-231-0/+1
| | | | | | | | | | | | | | | | | | | | | | | | Steps to reproduce and the error message ==== ``` > stack haddock basement ... snip ... Warning: 'A' is out of scope. Warning: 'haddock: internal error: <stdout>: commitBuffer: invalid argument (invalid character) ``` Environment ==== OS: Windows 10 ver. 1709 haddock: [HEAD of ghc-8.4 when I reproduce the error](https://github.com/haskell/haddock/commit/532b209d127e4cecdbf7e9e3dcf4f653a5605b5a). (I had to use this version to avoid another probrem already fixed in HEAD) GHC: 8.4.3 stack: Version 1.7.1, Git revision 681c800873816c022739ca7ed14755e85a579565 (5807 commits) x86_64 hpack-0.28.2 Related pull request ==== https://github.com/haskell/haddock/pull/566
* Add # as a special character (#884)Masahiro Sakai2018-07-201-1/+1
| | | | '#' has special meaning used for anchors and can be escaped using backslash. Therefore it would be nice to be listed as special characters.
* Additional tests for the identifier parser (#816)Simon Jakobi2018-07-202-10/+51
| | | | | | * Add tests for the identifier parser * docs: Clarify how to delimit identifiers
* Add some more unicode related tests (#872)Alec Theriault2018-07-202-0/+118
| | | | | | | 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. :)
* Fix broken instance source links (#869)Alec Theriault2018-07-202-19/+22
| | | | | | | | | 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.
* Preserve docs on type family instances (#867)Alec Theriault2018-07-204-18/+40
| | | | | | | | | * Preserve docs on type family instances The only problem was that the instance location was slightly off for type family instances. * Accept output
* tyThingToLHsDecl: Preserve type synonyms that contain a forall (#880)Simon Jakobi2018-07-191-2/+46
| | | | | | | | | | * tyThingToLHsDecls: Preserve type synonyms that contain a forall Fixes #879. * Add Note [Invariant: Never expand type synonyms] * Clarify Note [Invariant: Never expand type synonyms]
* Avoid line breaks due to line length in Hoogle (#868)Alec Theriault2018-07-063-3/+7
| | | | | | | | | | | | | * 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
* Export more fixities for Hoogle (#871)Alec Theriault2018-07-053-2/+31
| | | | This exports fixities for more things, including class methods and type-level operators.
* README updates (#856)Simon Jakobi2018-06-301-5/+36
| | | | | | | | | | * 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
* Drop GHC HEAD from CI and update GHC to 8.4.3Herbert Valerio Riedel2018-06-201-8/+2
| | | | | It's a waste of resource to even try to build this branch w/ ghc-head; so let's not do that...
* Renamer: Warn about ambiguous identifiers (#831)Simon Jakobi2018-06-082-5/+19
| | | | | | | | | | | | | | | | | | | * Renamer: Warn about ambiguous identifiers Example: Warning: 'elem' is ambiguous. It is defined * in ‘Data.Foldable’ * at /home/simon/tmp/hdk/src/Lib.hs:7:1 You may be able to disambiguate the identifier by qualifying it or by hiding some imports. Defaulting to 'elem' defined at /home/simon/tmp/hdk/src/Lib.hs:7:1 Fixes #830. * Deduplicate warnings Fixes #832.
* Improve hyperlinker's 'spanToNewline' (#846)Alec Theriault2018-06-053-7/+267
| | | | | | | | | | | | | | | | 'spanToNewline' is used to help break apart the source into lines which can then be partioned into CPP and non-CPP chunks. It is important that 'spanToNewline' not break apart tokens, so it needs to properly handle things like * block comments, possibly nested * string literals, possibly multi-line * CPP macros, possibly multi-line String literals in particular were not being properly handled. The fix is to to fall back in 'Text.Read.lex' to help lex things that are not comments. Fixes #837.
* Bump a few dependency bounds (#845)Simon Jakobi2018-06-052-7/+7
|
* Use `ClassOpSig` instead of `TypeSig` for class methods (#835)Alec Theriault2018-05-2313-140/+124
| | | | | | | | * Fix minimal pragma handling Class declarations contain 'ClassOpSig' not 'Typesig'. This should fix #834. * Accept html-test output
* Merge pull request #826 from haskell/T825Ryan Scott2018-05-163-5/+19
|\ | | | | Remove Hoogle backend hack that butchers infix datatype names
| * WibblesRyan Scott2018-05-101-3/+3
| |
| * Remove Hoogle backend hack that butchers infix datatype namesRyan Scott2018-05-103-2/+16
|/
* Renamer: Warn about out of scope identifiers. (#819)Simon Jakobi2018-05-081-6/+11
|
* Remove 'TokenGroup' from Hyperlinker (#818)Alec Theriault2018-05-081-50/+14
| | | | | Since the hyperlinker backend now relies on the GHC tokenizer, something like 'Bar.Baz.foo' already gets bunched together into one token (as opposed to being spread across 'Bar', '.', 'Baz', '.', and 'foo').
* Add docs for some DocH constructors (#814)Simon Jakobi2018-05-071-0/+3
|
* Filter out CRLFs in hyperlinker backend (#813)Alec Theriault2018-05-071-2/+7
| | | This prevents spurious lines from appearing in the final output.
* Replace 'attoparsec' with 'parsec' (#799)Alec Theriault2018-04-2517-2796/+363
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * 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
* Improve the Hoogle backend's treatment of type families (#808)Ryan Scott2018-04-243-6/+67
| | | Fixes parts 1 and 2 of #806.
* Add regression test for #413Ryan Scott2018-04-243-0/+22
| | | | Fixes #413.
* Don't treat fixity signatures like declarationsalexbiehl2018-04-201-1/+1
|
* Travis: Build with ghc-8.4.2 (#793)Alexander Biehl2018-04-034-9/+9
|
* Clear search string on hide for #781 (#789)Jack Henahan2018-04-033-4/+4
|
* Bump haddock and haddock-api to 2.20.0alexbiehl2018-03-282-3/+3
|
* haddock-2.19.1, haddock-api-2.19.1, haddock-library-1.6.0alexbiehl2018-03-274-4/+10
|
* @since includes package name (#749)Alec Theriault2018-03-2717-266/+346
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Metadoc stores a package name This means that '@since' annotations can be package aware. * Get the package name the right way This should extract the package name for `@since` annotations the right way. I had to move `modulePackageInfo` around to do this and, in the process, I took the liberty to update it. Since it appears that finding the package name is something that can fail, I added a warning for this case. * Silence warnings * Hide package for local 'since' annotations As discussed, this is still the usual case (and we should avoid being noisy for it). Although this commit is large, it is basically only about threading a 'Maybe Package' from 'Haddock.render' all the way to 'Haddock.Backends.Xhtml.DocMarkup.renderMeta'. * Bump binary interface version * Add a '--since-qual' option This controls when to qualify since annotations with the package they come from. The default is always, but I've left an 'external' variant where only those annotations coming from outside of the current package are qualified. * Make ParserSpec work * Make Fixtures work * Use package name even if package version is not available The @since stuff needs only the package name passed in, so it makes sense to not be forced to pass in a version too.
* Useful cost centres, timers and allocation counters (#785)Alexander Biehl2018-03-232-27/+53
| | | | | | | | | * Add some useful cost-centres for profiling * Add withTiming for each haddock phase Invoking haddock with `--optghc=-ddump-timings` now shows the amount of time spent and the number of allocated bytes for each phase.
* Prepare changelog for next releasealexbiehl2018-03-211-0/+4
|
* Show where instances are defined (#748)Alec Theriault2018-03-2124-112/+530
| | | | | | | | | | | | | | * Indicate source module of instances Above instance, we now also display a link to the module where the instance was defined. This is sometimes helpful in figuring out what to import. * Source module for type/data families too * Remove parens * Accept tests
* Make a proper definition for the <link> parserSimon Jakobi2018-03-141-4/+6
|
* haddock-library.cabal: Clean up GHC optionsSimon Jakobi2018-03-141-6/+3
|
* fixtures: Prevent stdout bufferingSimon Jakobi2018-03-141-1/+4
|
* fixtures: Slightly unmangle outputSimon Jakobi2018-03-141-1/+1
|
* Add fixture test for inline linksSimon Jakobi2018-03-142-0/+7
|
* Add fixture test for linksSimon Jakobi2018-03-142-0/+6
|
* Add fixture test for definition listsSimon Jakobi2018-03-142-0/+2
|
* Readme: Update GHC version (#778)Simon Jakobi2018-03-141-2/+2
|
* extractDecl: Extract constructor patterns from data family instances (#776)Alexander Biehl2018-03-131-13/+26
| | | | | | * extractDecl: Allow extraction of data family instance constructors * extractDecl: extract data family instance constructors
* Haddock: Straighten out base boundalexbiehl2018-03-101-1/+1
|
* Bump lower bound for haddock-libraryalexbiehl2018-03-101-1/+1
|
* Restore backward-compat with base-4.5 through base-4.8Herbert Valerio Riedel2018-03-102-2/+28
|
* Update to QC 2.11Herbert Valerio Riedel2018-03-102-2/+2
|
* Update changelogs for haddock-2.19.0.1 and haddock-library-1.5.0.1alexbiehl2018-03-102-0/+10
|