[GHC] #12050: Allow haddock comments on non-record types

GHC ghc-devs at haskell.org
Thu May 12 15:45:51 UTC 2016


#12050: Allow haddock comments on non-record types
-------------------------------------+-------------------------------------
        Reporter:  bgamari           |                Owner:
            Type:  feature request   |               Status:  new
        Priority:  normal            |            Milestone:
       Component:  Compiler          |              Version:  7.10.3
  (Parser)                           |
      Resolution:                    |             Keywords:
Operating System:  Unknown/Multiple  |         Architecture:
                                     |  Unknown/Multiple
 Type of failure:  None/Unknown      |            Test Case:
      Blocked By:                    |             Blocking:
 Related Tickets:                    |  Differential Rev(s):
       Wiki Page:                    |
-------------------------------------+-------------------------------------
Description changed by bgamari:

@@ -1,4 +1,3 @@
- There are a variety of cases
- I have found myself wanting to place haddock documentation on fields of
- non-record data types rather often in the past. The syntax for this might
- look like,
+ There are a variety of cases where I have found myself wanting to place
+ haddock documentation on fields of non-record data types rather often in
+ the past. The syntax for this might look like,

New description:

 There are a variety of cases where I have found myself wanting to place
 haddock documentation on fields of non-record data types rather often in
 the past. The syntax for this might look like,
 {{{#!hs
 data Foo = Foo      -- ^ A foo
              Int    -- ^ how big is the foo?
              String -- ^ the name of the foo
 }}}

--

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


More information about the ghc-tickets mailing list