ndmitchell / hoogle

Haskell API search engine
http://hoogle.haskell.org/
Other
753 stars 137 forks source link

Problems with comments. #225

Closed AnthonyJacob closed 7 years ago

AnthonyJacob commented 7 years ago

Some comments cause parse errors: -- *, -- |=, {- | -}.

If any of these are anywhere in my file, running stack hoogle will throw a parsing error!

ndmitchell commented 7 years ago

These are really bugs/restrictions of Haddock, and if you just do stack haddock (which generates the documentation for your package) you get the same issues. I strongly recommend fixing them, as if you don't, your package won't have documentation when you upload it to Stackage.