[GHC] #13003: improve documentation for typed TH and make it more discoverable

GHC ghc-devs at haskell.org
Sun Dec 18 23:56:53 UTC 2016


#13003: improve documentation for typed TH and make it more discoverable
-------------------------------------+-------------------------------------
           Reporter:  carter         |             Owner:
               Type:  bug            |            Status:  new
           Priority:  normal         |         Milestone:  8.2.1
          Component:  Documentation  |           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:
-------------------------------------+-------------------------------------
 theres quite a sparsity of documentation and dearth of discoverability for
 typed TH in the Template Haskell Library haddocks and the GHC manual, this
 probably wouldn't be much work to make it vastly better.


 one specific two course of action might be

 a) adding to the template haskell library a module
 `Language.Haskell.TH.Typed` that only exports the stuff in
 `Language.Haskell.TH` that is needed for typed TH (namely the newtype
 `TExp` but not its constructor), plus perhaps the function `unTypeQ :: Q
 (TExp a) -> Q Exp` and additionally documents how to use typed TH splices
 and quotations.

 b) add a clear section to the manual that perhaps touches on some of this
 too? (its not clear if theres any real docs in the ghc manual on this :(
 )

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


More information about the ghc-tickets mailing list