[GHC] #10398: Support consecutive named Haddock comments

GHC ghc-devs at haskell.org
Sat May 9 21:23:21 UTC 2015


#10398: Support consecutive named Haddock comments
-------------------------------------+-------------------------------------
              Reporter:  dmcclean    |             Owner:
                  Type:  bug         |            Status:  new
              Priority:  normal      |         Milestone:
             Component:  Compiler    |           Version:  7.10.1
  (Parser)                           |  Operating System:  Unknown/Multiple
              Keywords:              |   Type of failure:  Other
          Architecture:              |        Blocked By:
  Unknown/Multiple                   |   Related Tickets:
             Test Case:              |
              Blocking:              |
Differential Revisions:              |
-------------------------------------+-------------------------------------
 (I don't sufficiently understand the manner in which this arises from a
 GHC issue, but reliable sources inform me that it does.)

 This haddock issue, https://github.com/haskell/haddock/issues/392,
 apparently is related to the manner in which GHC parses comments.

 The way it manifests is that

 {{{#!hs
 module Foo
 (
   -- $chunk1
   -- $chunk2
   foo,
   -- $chunk3
   bar
 )
 where

 {- $chunk1
 This is chunk 1.
 -}

 {- $chunk2
 This is chunk 2.
 -}

 {- $chunk3
 This is chunk 3.
 -}

 foo = 3
 bar = 7
 }}}

 The resulting haddock documentation will include chunks 1 and 3 but not 2.

 See the linked ticket for a discussion by Mateusz Kowalczyk explaining how
 this relates to GHC.

--
Ticket URL: <http://ghc.haskell.org/trac/ghc/ticket/10398>
GHC <http://www.haskell.org/ghc/>
The Glasgow Haskell Compiler


More information about the ghc-tickets mailing list