Commit 377d5a26 authored by Ben Gamari's avatar Ben Gamari 🐢
Browse files

base: Add missing @since annotations in GHC.TypeNats

[skip ci]
parent fa8035e3
...@@ -103,6 +103,8 @@ infixl 7 * ...@@ -103,6 +103,8 @@ infixl 7 *
infixr 8 ^ infixr 8 ^
-- | Comparison of type-level naturals, as a constraint. -- | Comparison of type-level naturals, as a constraint.
--
-- @since 4.7.0.0
type x <= y = (x <=? y) ~ 'True type x <= y = (x <=? y) ~ 'True
-- | Comparison of type-level naturals, as a function. -- | Comparison of type-level naturals, as a function.
...@@ -117,12 +119,18 @@ Please let us know, if you encounter discrepancies between the two. -} ...@@ -117,12 +119,18 @@ Please let us know, if you encounter discrepancies between the two. -}
type family (m :: Nat) <=? (n :: Nat) :: Bool type family (m :: Nat) <=? (n :: Nat) :: Bool
-- | Addition of type-level naturals. -- | Addition of type-level naturals.
--
-- @since 4.7.0.0
type family (m :: Nat) + (n :: Nat) :: Nat type family (m :: Nat) + (n :: Nat) :: Nat
-- | Multiplication of type-level naturals. -- | Multiplication of type-level naturals.
--
-- @since 4.7.0.0
type family (m :: Nat) * (n :: Nat) :: Nat type family (m :: Nat) * (n :: Nat) :: Nat
-- | Exponentiation of type-level naturals. -- | Exponentiation of type-level naturals.
--
-- @since 4.7.0.0
type family (m :: Nat) ^ (n :: Nat) :: Nat type family (m :: Nat) ^ (n :: Nat) :: Nat
-- | Subtraction of type-level naturals. -- | Subtraction of type-level naturals.
...@@ -132,14 +140,20 @@ type family (m :: Nat) - (n :: Nat) :: Nat ...@@ -132,14 +140,20 @@ type family (m :: Nat) - (n :: Nat) :: Nat
-- | Division (round down) of natural numbers. -- | Division (round down) of natural numbers.
-- @Div x 0@ is undefined (i.e., it cannot be reduced). -- @Div x 0@ is undefined (i.e., it cannot be reduced).
--
-- @since 4.11.0.0
type family Div (m :: Nat) (n :: Nat) :: Nat type family Div (m :: Nat) (n :: Nat) :: Nat
-- | Modulus of natural numbers. -- | Modulus of natural numbers.
-- @Mod x 0@ is undefined (i.e., it cannot be reduced). -- @Mod x 0@ is undefined (i.e., it cannot be reduced).
--
-- @since 4.11.0.0
type family Mod (m :: Nat) (n :: Nat) :: Nat type family Mod (m :: Nat) (n :: Nat) :: Nat
-- | Log base 2 (round down) of natural numbers. -- | Log base 2 (round down) of natural numbers.
-- @Log 0@ is undefined (i.e., it cannot be reduced). -- @Log 0@ is undefined (i.e., it cannot be reduced).
--
-- @since 4.11.0.0
type family Log2 (m :: Nat) :: Nat type family Log2 (m :: Nat) :: Nat
-------------------------------------------------------------------------------- --------------------------------------------------------------------------------
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment