Core Lib Documentation: boolean module

corelib/src/boolean.cairo

@@ -1,6 +1,38 @@
+//! Boolean operations.
+//!
+//! The `bool` type is a primitive type in Cairo representing a boolean value that can be either
+//! `true` or `false`. This module provides trait implementations for boolean operations.
+//!
+//! # Examples
+//!
+//! Basic boolean operations:
+//!
+//! ```
+//!
+//! let value = true;
+//! assert!(value == true);
+//! assert!(!value == false);
+//! ```
+//!
+//! Converting to optional values with [`BoolTrait::then_some`]:
+//!
+//! ```
+//! use core::boolean::BoolTrait;
+//!
+//! let bool_value = true;
+//! let result = bool_value.then_some(42_u8);
+//! assert!(result == Option::Some(42));
+//!
+//! let bool_value = false;
+//! let result = bool_value.then_some(42_u8);
+//! assert!(result == Option::None);
+//! ```
+
+/// Basic trait for boolean operations.
+/// Explicit import of `BoolTrait` is required with `use core::boolean::BoolTrait;`.
 #[generate_trait]
 pub impl BoolImpl<T, +Drop<T>> of BoolTrait<T> {
-    /// Returns `Some(t)` if the `bool` is `true`, or `None` otherwise.
+    /// Returns `Option::Some(t)` if the `bool` is `true`, `Option::None` otherwise.
     ///
     /// # Examples
     ///