[GHC] #12405: Add expansions of abbreviated type names in documentation
#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
#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 Resolution: | Keywords: Operating System: Unknown/Multiple | Architecture: | Unknown/Multiple Type of failure: None/Unknown | Test Case: Blocked By: | Blocking: Related Tickets: | Differential Rev(s): D2406 Wiki Page: | -------------------------------------+------------------------------------- Changes (by syd): * differential: => D2406 -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/12405#comment:1 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler
#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 Resolution: | Keywords: Operating System: Unknown/Multiple | Architecture: | Unknown/Multiple Type of failure: None/Unknown | Test Case: Blocked By: | Blocking: Related Tickets: | Differential Rev(s): Phab:D2406 Wiki Page: | -------------------------------------+------------------------------------- Changes (by syd): * differential: D2406 => Phab:D2406 -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/12405#comment:2 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler
#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
Resolution: | Keywords:
Operating System: Unknown/Multiple | Architecture:
| Unknown/Multiple
Type of failure: None/Unknown | Test Case:
Blocked By: | Blocking:
Related Tickets: | Differential Rev(s): Phab:D2406
Wiki Page: |
-------------------------------------+-------------------------------------
Comment (by Ben Gamari
#12405: Add expansions of abbreviated type names in documentation -------------------------------------+------------------------------------- Reporter: syd | Owner: Type: task | Status: closed Priority: lowest | Milestone: Component: GHC API | Version: 8.0.1 Resolution: fixed | Keywords: Operating System: Unknown/Multiple | Architecture: | Unknown/Multiple Type of failure: None/Unknown | Test Case: Blocked By: | Blocking: Related Tickets: | Differential Rev(s): Phab:D2406 Wiki Page: | -------------------------------------+------------------------------------- Changes (by bgamari): * status: new => closed * resolution: => fixed Comment: Thanks syd! -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/12405#comment:4 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler
participants (1)
-
GHC