Closed istathar closed 4 years ago
We prefer inline style of comments. As many other things about formatting it is a matter of taste. Otherwise I'm closing this as a duplicate of #589 (well, your issue is older but it is also a request to change our current haddock style).
This code (highlighted here) uses an idiom that I use quite a bit. We put Haddock in multi-line
{-| ... -}
comments (partly so they can be margin aligned text, and partly because editors syntax highlight colour such text differently) and code comments in--
wherever needed.Doing both together caused ormolu to error out with the following message:
Removing the code comment line allowed the formatter to work, but we noticed that it ate the multi-line comment and turned it into
--| ...
which is suboptimal from the point of view of differentiating Haddock comments from code comments. Is this something that could be reconsidered?