#5467: Template Haskell: support for Haddock comments
---------------------------------+------------------------------------------
Reporter: reinerp | Owner:
Type: feature request | Status: new
Priority: normal | Milestone:
Component: Template Haskell | Version: 7.2.1
Keywords: | Testcase:
Blockedby: | Difficulty:
Os: Unknown/Multiple | Blocking:
Architecture: Unknown/Multiple | Failure: None/Unknown
---------------------------------+------------------------------------------
Comment(by JeremyShaw):
Hello,
It seems like there are (at least) two ways haddock and template-haskell
could interact:
1. Writing template-haskell code that also *generates* haddock comments
2. Allow the user to write haddock documentation for generated code by
hand.
If the generated functions do not include type signatures, then you can
write a type-signature by hand and document things the normal way. But if
the template-haskell code generates a type signature, then you will get an
error if you try to add a type signature by hand as well. You could use
#ifdefs to get around that, but then you would not get a compiler error if
the hand written, haddock-only type signatures get out of sync with the
generated code.
Written a type signature by hand for a generated function can be sensible.
Not sure what to do about generated types however..
--
Ticket URL: <http://hackage.haskell.org/trac/ghc/ticket/5467#comment:3>
GHC <http://www.haskell.org/ghc/>
The Glasgow Haskell Compiler
_______________________________________________
Glasgow-haskell-bugs mailing list
[email protected]
http://www.haskell.org/mailman/listinfo/glasgow-haskell-bugs
