Update binary integer description documentation (#131).

oscbyspro · Nov 15, 2024 · 45cc68e · 45cc68e
1 parent b2144f0
commit 45cc68e
Show file tree

Hide file tree

Showing 2 changed files with 69 additions and 7 deletions.
diff --git a/Sources/CoreKit/BinaryInteger+Text.swift b/Sources/CoreKit/BinaryInteger+Text.swift
@@ -20,6 +20,14 @@
     // MARK: Initializers
     //=------------------------------------------------------------------------=
 
+    /// Decodes the `description`, if possible.
+    ///
+    /// ### Binary Integer Description
+    ///
+    /// - Note: The default format is `TextInt.decimal`.
+    ///
+    /// - Note: Decoding failures throw `TextInt.Error`.
+    ///
     @inlinable public init?(_ description: String) {
         always: do {
             self = try TextInt.decimal.decode(description)
@@ -28,6 +36,14 @@
         }
     }
 
+    /// Decodes the `description` using the given `format`, if possible.
+    ///
+    /// ### Binary Integer Description
+    ///
+    /// - Note: The default format is `TextInt.decimal`.
+    ///
+    /// - Note: Decoding failures throw `TextInt.Error`.
+    ///
     @inlinable public init(_ description: some StringProtocol, using format: TextInt) throws {
         self = try format.decode(description)
     }
@@ -36,10 +52,26 @@
     // MARK: Utilities
     //=------------------------------------------------------------------------=
     
+    /// Returns the `description` of `self`.
+    ///
+    /// ### Binary Integer Description
+    ///
+    /// - Note: The default format is `TextInt.decimal`.
+    ///
+    /// - Note: Decoding failures throw `TextInt.Error`.
+    ///
     @inlinable public var description: String {
         self.description(using: TextInt.decimal)
     }
 
+    /// Returns the `description` of `self` using the given `format`.
+    ///
+    /// ### Binary Integer Description
+    ///
+    /// - Note: The default format is `TextInt.decimal`.
+    ///
+    /// - Note: Decoding failures throw `TextInt.Error`.
+    ///
     @inlinable public func description(using format: TextInt) -> String {
         format.encode(self)
     }

diff --git a/Sources/StdlibIntKit/StdlibInt+Text.swift b/Sources/StdlibIntKit/StdlibInt+Text.swift
@@ -22,7 +22,15 @@ extension StdlibInt {
 
     /// Decodes the decimal `description`, if possible.
     ///
-    /// - Note: This method uses `TextInt`.
+    /// ### Binary Integer Description
+    ///
+    /// - Note: The default format is `TextInt.decimal`.
+    ///
+    /// - Note: Decoding failures throw `TextInt.Error`.
+    ///
+    /// ### Binary Integer Description (StdlibInt)
+    ///
+    /// - Note: `String.init(_:radix:)` does not use `TextInt`.
     ///
     @inlinable public init?(_ description: String) {
         if  let base = Base(description) {
@@ -32,9 +40,17 @@ extension StdlibInt {
         }
     }
 
-    /// Decodes the `format` `description`, if possible.
+    /// Decodes the `description` using the given `format`, if possible.
+    ///
+    /// ### Binary Integer Description
+    ///
+    /// - Note: The default format is `TextInt.decimal`.
+    ///
+    /// - Note: Decoding failures throw `TextInt.Error`.
+    ///
+    /// ### Binary Integer Description (StdlibInt)
     ///
-    /// - Note: This method uses `TextInt`.
+    /// - Note: `String.init(_:radix:)` does not use `TextInt`.
     ///
     @inlinable public init(_ description: some StringProtocol, as format: TextInt) throws {
         try self.init(Base(description, using: format))
@@ -44,17 +60,31 @@ extension StdlibInt {
     // MARK: Utilities
     //=------------------------------------------------------------------------=
 
-    /// Returns the decimal `description` of `self`.
+    /// Returns the `description` of `self`.
+    ///
+    /// ### Binary Integer Description
+    ///
+    /// - Note: The default format is `TextInt.decimal`.
     ///
-    /// - Note: This method uses `TextInt`.
+    /// - Note: Decoding failures throw `TextInt.Error`.
+    ///
+    /// ### Binary Integer Description (StdlibInt)
+    ///
+    /// - Note: `String.init(_:radix:)` does not use `TextInt`.
     ///
     @inlinable public var description: String {
         self.base.description
     }
 
-    /// Returns the `format` `description` of `self`.
+    /// Returns the `description` of `self` using the given `format`.
+    ///
+    /// ### Binary Integer Description
+    ///
+    /// - Note: The default format is `TextInt.decimal`.
+    ///
+    /// - Note: Decoding failures throw `TextInt.Error`.
     ///
-    /// - Note: This method uses `TextInt`.
+    /// ### Binary Integer Description (StdlibInt)
     ///
     /// - Note: `String.init(_:radix:)` does not use `TextInt`.
     ///