base: Add missing @since annotations in GHC.TypeNats
authorBen Gamari <ben@smart-cactus.org>
Tue, 3 Oct 2017 19:04:16 +0000 (15:04 -0400)
committerBen Gamari <ben@smart-cactus.org>
Tue, 3 Oct 2017 21:07:36 +0000 (17:07 -0400)
[skip ci]

libraries/base/GHC/TypeNats.hs

index e3322a2..a5ee0fc 100644 (file)
@@ -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
 
 --------------------------------------------------------------------------------