Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP

Loading…

tasty-hunit documentation does not build #59

Closed
ocharles opened this Issue · 4 comments

3 participants

@ocharles
Collaborator
Building tasty-hunit-0.8...
Preprocessing library tasty-hunit-0.8...
[1 of 1] Compiling Test.Tasty.SmallCheck ( Test/Tasty/SmallCheck.hs, dist/build/Test/Tasty/SmallCheck.o )
[1 of 1] Compiling Test.Tasty.QuickCheck ( Test/Tasty/QuickCheck.hs, dist/build/Test/Tasty/QuickCheck.o )
[1 of 1] Compiling Test.Tasty.HUnit ( Test/Tasty/HUnit.hs, dist/build/Test/Tasty/HUnit.o )
In-place registering tasty-hunit-0.8...
Running Haddock for tasty-hunit-0.8...
Preprocessing library tasty-hunit-0.8...
Warning: The documentation for the following packages are not installed. No
links will be generated to these packages: rts-1.0

dist/build/tmp-8206/Test/Tasty/HUnit.hs:54:5:
    parse error on input `hunitResult'
Haddock coverage:
builder for `/nix/store/5pbg70gmgs2x5gz7yj1aqii76q6cm96z-haskell-tasty-hunit-ghc7.6.3-0.8.drv' failed with exit code 1
cannot build derivation `/nix/store/llbs5ihy9fi8j37ada6lv7g05sahlkx4-haskell-tasty-rerun-ghc7.6.3-1.0.0.drv': 1 dependencies couldn't be built
error: build of `/nix/store/llbs5ihy9fi8j37ada6lv7g05sahlkx4-haskell-tasty-rerun-ghc7.6.3-1.0.0.drv' failed
@feuerbach
Owner

Thanks for the report.

It looks like haddock doesn't like asterisks in this comment. Which is strange because that comment isn't marked as a haddock comment, so why does haddock care?

I've uploaded a "fixed" version.

@Fuuzetsu

@feuerbach
Comments starting with -- * are in fact Haddock comments, it's a syntax for top-level headers, usually used in the export list. This kind of header appears where Haddock doesn't know what to do with it so it breaks.

I suggest that you either change the * to a different character (such as -) or turn the whole comment to a {- -} style comment at which point I think there should be no problem.

@feuerbach
Owner

Ah, I forgot about that. Thanks for the explanation, @Fuuzetsu.

@feuerbach feuerbach closed this
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Something went wrong with that request. Please try again.