Core Lib Documentation: One module (#6780)

Co-authored-by: enitrat <[email protected]>

Author: TAdev0

corelib/src/num/traits/one.cairo

@@ -1,9 +1,46 @@
+//! Traits for types with a multiplicative identity element.
+
 /// Defines a multiplicative identity element for `T`.
+///
+/// # Laws
+///
+/// ```text
+/// a * 1 = a       ∀ a ∈ T
+/// 1 * a = a       ∀ a ∈ T
+/// ```
 pub trait One<T> {
     /// Returns the multiplicative identity element of `T`, `1`.
+    ///
+    /// # Examples
+    ///
+    /// ```
+    /// use core::num::traits::One;
+    ///
+    /// assert!(One::<u32>::one() == 1);
+    /// ```
     fn one() -> T;
-    /// Returns `true` if `self` is equal to the multiplicative identity.
+
+    /// Returns true if `self` is equal to the multiplicative identity.
+    ///
+    /// # Examples
+    ///
+    /// ```
+    /// use core::num::traits::One;
+    ///
+    /// assert!(1.is_one());
+    /// assert!(!0.is_one());
+    /// ```
     fn is_one(self: @T) -> bool;
-    /// Returns `false` if `self` is equal to the multiplicative identity.
+
+    /// Returns false if `self` is equal to the multiplicative identity.
+    ///
+    /// # Examples
+    ///
+    /// ```
+    /// use core::num::traits::One;
+    ///
+    /// assert!(0.is_non_one());
+    /// assert!(!1.is_non_one());
+    /// ```
     fn is_non_one(self: @T) -> bool;
 }