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

Modify some comments that steal haddock syntax #256

Merged
merged 1 commit into from
Aug 13, 2020
Merged

Modify some comments that steal haddock syntax #256

merged 1 commit into from
Aug 13, 2020

Conversation

georgefst
Copy link
Contributor

@georgefst georgefst commented Jul 20, 2020

Some comments unfortunately began with *. In most cases, this was being used for bullet lists, where adding an extra space is more consistent with the rest of the comment block anyway.

Fixes #253, fixes #229.

@georgefst
Copy link
Contributor Author

Come to think of it, it probably wouldn't take much of a modification to the CI to stop these issues from creeping back in.

@sir4ur0n
Copy link

Hi,

I just came across this problem too while enabling haddock for all my dependencies (for Haskell Language Server display of dependencies doc). Can this PR please be considered and merged?

Thank you!

@sir4ur0n
Copy link

FYI until this is merged, I use the following in my stack.yaml:

extra-deps:
  - git: git@github.com:georgefst/c2hs.git
    commit: e457b27727f17599cb61d646039019ca24acbbef

@georgefst
Copy link
Contributor Author

Yeah, likewise I have:

source-repository-package
  type: git
  location: git://github.com/georgefst/c2hs.git
  tag: e457b27727f17599cb61d646039019ca24acbbef

in several cabal.projects.

@georgefst
Copy link
Contributor Author

I believe this will be much less of an issue with GHC 9.0, as these errors will be rightly downgraded to warnings. But hopefully somebody is able to merge this soon anyway, since it's about as trivial a patch as possible.

@deech?

@deech
Copy link
Contributor

deech commented Aug 13, 2020

Oh no! I didn't get a notification for this any of the other PRs and issues in this project until you just @'ed me directly. Merging this now.

@deech deech merged commit bbf5fb4 into haskell:master Aug 13, 2020
@georgefst
Copy link
Contributor Author

@deech Ha, I've been there before, somehow - Github works in mysterious ways.

Thanks for the quick response!

@sir4ur0n
Copy link

Thank you!

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 this pull request may close these issues.

Unable to build documentation cabal install fails with ghc-options=-haddock
3 participants