diff options
| author | Herbert Valerio Riedel <hvr@gnu.org> | 2013-09-21 14:16:45 +0200 |
|---|---|---|
| committer | Herbert Valerio Riedel <hvr@gnu.org> | 2013-09-21 14:16:45 +0200 |
| commit | 77f32dad3bef5b641a9d15f69ad2e0f058ade67a (patch) | |
| tree | fa9f41552d5dde6ce6ac1700d4ed3c44b2aa2652 /libraries/base/Data/Type/Equality.hs | |
| parent | 957511b3816ec58c02fd33d5d115f7f6eef2b6b8 (diff) | |
| download | haskell-77f32dad3bef5b641a9d15f69ad2e0f058ade67a.tar.gz | |
Add Haddock `/Since: 4.7.0.0/` comments to new symbols
These annotations were added in such a way, that the line
{{{
/Since: 4.7.0.0/
}}}
represents the last paragraph of the Haddock comment.
Maybe Haddock will have support for this meta-syntax at some point, and
be able to inherited the since-version property to the children of an
annotated symbol and display the since-version property in the rendered
documentation only in cases when it's not visually obvious (for
instance, when re-exporting documentation strings).
Signed-off-by: Herbert Valerio Riedel <hvr@gnu.org>
Diffstat (limited to 'libraries/base/Data/Type/Equality.hs')
| -rw-r--r-- | libraries/base/Data/Type/Equality.hs | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/libraries/base/Data/Type/Equality.hs b/libraries/base/Data/Type/Equality.hs index 62b0241d13..5293ce67d2 100644 --- a/libraries/base/Data/Type/Equality.hs +++ b/libraries/base/Data/Type/Equality.hs @@ -19,6 +19,7 @@ -- Definition of propositional equality @(:=:)@. Pattern-matching on a variable -- of type @(a :=: b)@ produces a proof that @a ~ b@. -- +-- /Since: 4.7.0.0/ ----------------------------------------------------------------------------- @@ -37,6 +38,8 @@ infix 4 :=: -- value, then the type @a@ is the same as the type @b@. To use this equality -- in practice, pattern-match on the @a :=: b@ to get out the @Refl@ constructor; -- in the body of the pattern-match, the compiler knows that @a ~ b@. +-- +-- /Since: 4.7.0.0/ data a :=: b where Refl :: a :=: a |