aboutsummaryrefslogtreecommitdiff
path: root/haddock-library/test
Commit message (Collapse)AuthorAgeFilesLines
* Fix CI (#1467)Steve Hart2022-03-251-0/+3
| | | | | | | | * CI: Reinstall GHC with docs CI tests were failing because the GHC preinstalled to the CI environment does not include documentation, which is required for running the Haddock tests. This commit causes the CI workflow to reinstall GHC with docs so that tests can succeed.
* Add support for labeled module referencesIñaki García Etxebarria2021-02-071-9/+75
| | | | | | | | | | 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".
* 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-081-2/+7
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * 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-081-0/+3
|
* Fix crash in `haddock-library` on unicode spaceAlec Theriault2020-03-271-1/+7
| | | | | | | | | | | | | 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
* Better identifier parsingAlec Theriault2019-02-251-1/+8
| | | | | | | | | | | | | | | | * '(<|>)' 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-251-0/+6
| | | | | | | | | | | 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)
* Remove `Documentation.Haddock.Utf8`Alec Theriault2019-02-031-14/+0
| | | | | | | | | | | | 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/add to haddock-library test suiteAlec Theriault2018-11-061-1/+5
|
* Additional tests for the identifier parser (#816)Simon Jakobi2018-07-201-1/+47
| | | | | | | | * Add tests for the identifier parser * docs: Clarify how to delimit identifiers (cherry picked from commit 0861affeca4d72938f05a2eceddfae2c19199071)
* @since includes package name (#749)Alec Theriault2018-03-271-5/+12
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * 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.
* Make test-suite SMP compatibleHerbert Valerio Riedel2018-02-051-0/+2
|
* Avoid trivial use of LambdaCaseHerbert Valerio Riedel2017-07-201-2/+1
| | | | otherwise we can't test w/ e.g. GHC 7.4.2
* Fix the documentation for haddock itself.Dominic Steinitz2015-12-211-0/+4
| | | | | | | | | | | | | | | Change notation and add support for inline math. Allow newlines in display math. Add a command line option for the mathjax url (you might want to use a locally installed version). Rebase tests because of extra url and version change. Respond to (some of the) comments. Fix warnings in InterfaceFile.hs
* Add arbitrary-indent spec test for parser.Łukasz Hanuszczak2015-06-031-0/+17
|
* Update test to account for \r filteringMateusz Kowalczyk2015-03-261-2/+5
|
* Allow the parser to spit out meta-infoMateusz Kowalczyk2014-12-101-7/+16
| | | | | | | | | | | | | | | Currently we only use it only for ‘since’ annotations but with these patches it should be fairly simple to add new attributes if we wish to. Closes #26. It seems to work fine but due to 7.10 rush I don't have the chance to do more exhaustive testing right now. The way the meta is output (emphasis at the end of the whole comment) is fairly arbitrary and subject to bikeshedding. Note that this makes test for Bug310 fail due to interface version bump: it can't find the docs for base with this interface version so it fails. There is not much we can do to help this because it tests for ’built-in’ identifier, not something we can provide ourselves.
* (wip) Add support for @since (closes #26)Simon Hengel2014-11-162-6/+25
|
* newtype-wrap parser monadSimon Hengel2014-11-081-1/+1
|
* Fix parsing of identifiers written in infix wayMateusz Kowalczyk2014-11-041-0/+6
|
* Allow an optional colon after the closing bracket of definition listsSimon Hengel2014-11-031-15/+27
| | | | | This is to disambiguate them from markdown links and will be require with a future release.
* Add support for markdown imagesSimon Hengel2014-11-031-13/+11
|
* Allow markdown links at the beginning of a paragraphSimon Hengel2014-11-031-3/+25
|
* Add support for markdown links (closes #336)Simon Hengel2014-11-031-0/+39
|
* Remove unused language extensionsSimon Hengel2014-11-031-1/+0
|
* Fix warningSimon Hengel2014-08-201-0/+1
|
* Fix #313 by doing some list munging.Mateusz Kowalczyk2014-08-151-1/+19
| | | | | | I get rid of the Monoid instance because we weren't satisfying the laws. Convenience of having <> didn't outweigh the shock-factor of having it behave badly.
* Catch mid-line URLs. Fixes #314.Mateusz Kowalczyk2014-07-281-0/+4
|
* Don't mangle append order for nested lists.Mateusz Kowalczyk2014-06-251-8/+8
| | | | | | | | The benefit of this is that the ‘top-level’ element of such lists is properly wrapped in <p> tags so any CSS working with these will be applied properly. It also just makes more sense. Pointed out at jgm/pandoc#1346.
* Drop DocParagraph from front of headersMateusz Kowalczyk2014-06-251-5/+4
| | | | | I can not remember why they were wrapped in paragraphs to begin with and it seems unnecessary now that I test it. Closes #307.
* Fix anchors. Closes #308.Mateusz Kowalczyk2014-06-251-0/+13
|
* Remove doctest dependencySimon Hengel2014-06-181-11/+0
| | | | (so that we can use haddock-library with doctest)
* Use doctest to check examples in documentationSimon Hengel2014-06-181-0/+11
|
* Compatibility with older versions of base and bytestringSimon Hengel2014-06-181-1/+1
|
* Move out Show and Eq instances to TypesMateusz Kowalczyk2014-05-051-8/+2
| | | | They are much more useful to the users here.
* Move parser + parser tests out to own package.Mateusz Kowalczyk2014-05-054-0/+853
We move some types out that are necessary as well and then re-export and specialise them in the core Haddock. Reason for moving out spec tests is that if we're working on the parser, we can simply work on that and we can ignore the rest of Haddock. The downside is that it's a little inconvenient if at the end of the day we want to see that everything passes.
generated by cgit v1.2.3 (git 2.39.1) at 2024-11-30 09:29:02 +0000