[GHC] #12405: Add expansions of abbreviated type names in documentation

18 Jul 2016

      #12405: Add expansions of abbreviated type names in documentation
-------------------------------------+-------------------------------------
           Reporter:  syd            |             Owner:
               Type:  task           |            Status:  new
           Priority:  lowest         |         Milestone:
          Component:  GHC API        |           Version:  8.0.1
           Keywords:                 |  Operating System:  Unknown/Multiple
       Architecture:                 |   Type of failure:  None/Unknown
  Unknown/Multiple                   |
          Test Case:                 |        Blocked By:
           Blocking:                 |   Related Tickets:
Differential Rev(s):                 |         Wiki Page:
-------------------------------------+-------------------------------------
 Type names are often abbreviated for programmer convenience, but they make
 using the GHC API much harder for newcomers.

 I would like to add some documentation to these declarations for ease of
 use.

 For example:

 {{{#!hs
 type LHsDecl id
 }}}

 ->

 {{{#!hs
 -- | Located Haskell Declaration
 type LHsDecl id
 }}}

 as opposed to

 {{{#!hs
 -- | Left-Hand side Declaration
 type LHsDecl id
 }}}

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