diff options
| author | chris-martin <ch.martin@gmail.com> | 2019-09-25 15:17:00 -0400 |
|---|---|---|
| committer | Marge Bot <ben+marge-bot@smart-cactus.org> | 2019-09-27 22:14:00 -0400 |
| commit | 444e554f6d034642f3f2a7c077cca412a6c22c5d (patch) | |
| tree | 03fc05cb70fa182caf72f57a0bed6fe68985e0f2 | |
| parent | 0201d0bf55cdca218a0eec89b8b9ccc55c0297d3 (diff) | |
| download | haskell-444e554f6d034642f3f2a7c077cca412a6c22c5d.tar.gz | |
Expand description of DataKinds to mention data constructors, and include mention of TypeError
| -rw-r--r-- | libraries/base/GHC/TypeLits.hs | 11 |
1 files changed, 8 insertions, 3 deletions
diff --git a/libraries/base/GHC/TypeLits.hs b/libraries/base/GHC/TypeLits.hs index ce1eb1fcb3..1108fd23bd 100644 --- a/libraries/base/GHC/TypeLits.hs +++ b/libraries/base/GHC/TypeLits.hs @@ -13,9 +13,14 @@ {-# LANGUAGE MagicHash #-} {-# LANGUAGE PolyKinds #-} -{-| There are two kinds of data representable at the type level using -GHC's @DataKinds@ extension to the Haskell language: natural numbers -(the 'Nat' kind) and type-level strings (the 'Symbol' kind). +{-| + +GHC's @DataKinds@ language extension lifts data constructors, natural +numbers, and strings to the type level. This module provides the +primitives needed for working with type-level numbers (the 'Nat' kind) +and strings (the 'Symbol') kind. It also defines the 'TypeError' type +family, a feature that makes use of type-level strings to support user +defined type errors. For now, this module is the API for working with type-level literals. However, please note that it is a work in progress and is subject to change. |