search

haskell / c2hs

c2hs is a pre-processor for Haskell FFI bindings to C libraries
http://hackage.haskell.org/package/c2hs
Other
197 stars 50 forks source link

Modify some comments that steal haddock syntax #256

Closed georgefst closed 3 years ago

georgefst commented 3 years ago

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 commented 3 years ago

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 commented 3 years ago

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 commented 3 years ago

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 commented 3 years ago

Yeah, likewise I have:

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

in several cabal.projects.

georgefst commented 3 years ago

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 commented 3 years ago

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.

georgefst commented 3 years ago

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

Thanks for the quick response!

sir4ur0n commented 3 years ago

Thank you!