Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

haddock generation broken #511

Closed
cdepillabout opened this issue Nov 29, 2019 · 2 comments · Fixed by #516
Closed

haddock generation broken #511

cdepillabout opened this issue Nov 29, 2019 · 2 comments · Fixed by #516

Comments

@cdepillabout
Copy link
Collaborator

Haddock generation appears broken for spago.

When trying to generate haddocks, I get errors like the following:

src/Spago/FetchPackage.hs:111:5: error:
    parse error on input ‘-- * if a Package is in the global cache, copy it to the local cache’
    |
111 |     -- * if a Package is in the global cache, copy it to the local cache
    |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

I believe this is caused by an unfortunate feature of haddock that doesn't allow haddock-style markup in comments that are not proper haddocks.


I recently fixed something in purescript similar: purescript/purescript#3745

@f-f
Copy link
Member

f-f commented Nov 29, 2019

@cdepillabout right, I think I never generated Haddocks for the package ever. Want to have a go at this?

@cdepillabout
Copy link
Collaborator Author

cdepillabout commented Nov 30, 2019

@f-f I'll take a look at this and see if I can get something working.

edit: Sent a PR fixing this in #516.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants