summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBen Gamari <ben@smart-cactus.org>2017-10-03 15:04:16 -0400
committerBen Gamari <ben@smart-cactus.org>2017-10-03 17:07:36 -0400
commit377d5a262ba7e065dc6fb4683a8053f0e5e1379c (patch)
tree13b6770141e56b94b36527aea28a2524b8e29c59
parentfa8035e3ee83aff5a20fc5e7e2697bac1686d6a6 (diff)
downloadhaskell-377d5a262ba7e065dc6fb4683a8053f0e5e1379c.tar.gz
base: Add missing @since annotations in GHC.TypeNats
[skip ci]
-rw-r--r--libraries/base/GHC/TypeNats.hs14
1 files changed, 14 insertions, 0 deletions
diff --git a/libraries/base/GHC/TypeNats.hs b/libraries/base/GHC/TypeNats.hs
index e3322a2a25..a5ee0fc537 100644
--- a/libraries/base/GHC/TypeNats.hs
+++ b/libraries/base/GHC/TypeNats.hs
@@ -103,6 +103,8 @@ infixl 7 *
infixr 8 ^
-- | Comparison of type-level naturals, as a constraint.
+--
+-- @since 4.7.0.0
type x <= y = (x <=? y) ~ 'True
-- | Comparison of type-level naturals, as a function.
@@ -117,12 +119,18 @@ Please let us know, if you encounter discrepancies between the two. -}
type family (m :: Nat) <=? (n :: Nat) :: Bool
-- | Addition of type-level naturals.
+--
+-- @since 4.7.0.0
type family (m :: Nat) + (n :: Nat) :: Nat
-- | Multiplication of type-level naturals.
+--
+-- @since 4.7.0.0
type family (m :: Nat) * (n :: Nat) :: Nat
-- | Exponentiation of type-level naturals.
+--
+-- @since 4.7.0.0
type family (m :: Nat) ^ (n :: Nat) :: Nat
-- | Subtraction of type-level naturals.
@@ -132,14 +140,20 @@ type family (m :: Nat) - (n :: Nat) :: Nat
-- | Division (round down) of natural numbers.
-- @Div x 0@ is undefined (i.e., it cannot be reduced).
+--
+-- @since 4.11.0.0
type family Div (m :: Nat) (n :: Nat) :: Nat
-- | Modulus of natural numbers.
-- @Mod x 0@ is undefined (i.e., it cannot be reduced).
+--
+-- @since 4.11.0.0
type family Mod (m :: Nat) (n :: Nat) :: Nat
-- | Log base 2 (round down) of natural numbers.
-- @Log 0@ is undefined (i.e., it cannot be reduced).
+--
+-- @since 4.11.0.0
type family Log2 (m :: Nat) :: Nat
--------------------------------------------------------------------------------