[GHC] #2168: ghci should show haddock comments for identifier

GHC ghc-devs at haskell.org
Sun Nov 20 11:11:09 UTC 2016


#2168: ghci should show haddock comments for identifier
-------------------------------------+-------------------------------------
        Reporter:  j.waldmann        |                Owner:
            Type:  feature request   |               Status:  new
        Priority:  normal            |            Milestone:
       Component:  GHCi              |              Version:  6.8.2
      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:                    |
-------------------------------------+-------------------------------------

Comment (by adamse):

 I am intersted in implementing this. Does anyone have any thoughts about
 how? Perhaps someone has already started on this a bit?

 My tentative plan of attack is

 1. Modify ghc to include the docs in interface files
    (Modify IfaceSyn.IfaceDecl to optionally include docs)
 2. Add a :doc command to ghci

 Once that is done the next step would be to modify Haddock to take
 advantage of this.

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


More information about the ghc-tickets mailing list