[commit: ghc] master: base: Add missing @since annotations in GHC.TypeNats (377d5a2)
git at git.haskell.org
git at git.haskell.org
Tue Oct 3 21:56:29 UTC 2017
Repository : ssh://git@git.haskell.org/ghc
On branch : master
Link : http://ghc.haskell.org/trac/ghc/changeset/377d5a262ba7e065dc6fb4683a8053f0e5e1379c/ghc
>---------------------------------------------------------------
commit 377d5a262ba7e065dc6fb4683a8053f0e5e1379c
Author: Ben Gamari <ben at smart-cactus.org>
Date: Tue Oct 3 15:04:16 2017 -0400
base: Add missing @since annotations in GHC.TypeNats
[skip ci]
>---------------------------------------------------------------
377d5a262ba7e065dc6fb4683a8053f0e5e1379c
libraries/base/GHC/TypeNats.hs | 14 ++++++++++++++
1 file changed, 14 insertions(+)
diff --git a/libraries/base/GHC/TypeNats.hs b/libraries/base/GHC/TypeNats.hs
index e3322a2..a5ee0fc 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
--------------------------------------------------------------------------------
More information about the ghc-commits
mailing list