[GHC] #11765: Allow documentary type signatures
GHC
ghc-devs at haskell.org
Mon Mar 28 22:56:06 UTC 2016
#11765: Allow documentary type signatures
-------------------------------------+-------------------------------------
Reporter: dfeuer | Owner:
Type: feature | Status: new
request |
Priority: normal | Milestone: 8.2.1
Component: Compiler | Version: 7.10.3
(Type checker) |
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:
-------------------------------------+-------------------------------------
In some cases (e.g., `lens`) it's useful to document a binding with a more
specific type signature than the true one, to show a useful special case.
Unfortunately, this documentation can potentially be wrong or go out of
date. I'd like to propose a pragma for this:
{{{#!hs
{-# Documentary #-} f :: T -> U
}}}
would ask the type checker to verify that `f :: T -> U`. Specifically, it
would have the effect of creating and type checking, but then discarding,
a hidden binding
{{{#!hs
f_doc :: T -> U
f_doc t = f t
}}}
--
Ticket URL: <http://ghc.haskell.org/trac/ghc/ticket/11765>
GHC <http://www.haskell.org/ghc/>
The Glasgow Haskell Compiler
More information about the ghc-tickets
mailing list