Cleanup.

Author: oscbyspro

Sources/DiffableTextKit/Helpers/Carets.swift

@@ -11,11 +11,10 @@
 // MARK: * Carets
 //*============================================================================*
 
-/// A lower and upper caret represented by a lower and upper bound.
+/// Up to two carets represented by a lower and upper bound.
 ///
-/// It differs from a normal range in that equal bounds represent a single upper caret,
-/// rather than two carets at a shared location, which is observable by methods such
-/// as map(lower:upper:).
+/// When its bounds are equal, it represents a single upper caret.
+/// This distinction matters to transformations such as map(lower:upper:).
 ///
 @usableFromInline struct Carets<Bound: Comparable>: Equatable {
 

Sources/DiffableTextKit/Helpers/Index.swift

@@ -11,6 +11,7 @@
 // MARK: * Index
 //*========================================================================*
 
+/// A character encoded index and offset.
 public struct Index: Comparable {
 
     //=--------------------------------------------------------------------=
@@ -23,11 +24,27 @@ public struct Index: Comparable {
     //=--------------------------------------------------------------------=
     // MARK: Initializers
     //=--------------------------------------------------------------------=
-
+    
+    /// Creates an instance describing a character's location.
+    ///
+    /// - Parameters:
+    ///   - character: The character encoded index.
+    ///   - attribute: The character encoded offset.
+    ///
     @inlinable init(_ character: String.Index, _ attribute: Int) {
         self.character = character
         self.attribute = attribute
     }
+    
+    /// Creates an instance describing a character's location.
+    ///
+    /// - Parameters:
+    ///   - character: The character encoded index.
+    ///   - characters: The collection of characters that contains the index.
+    ///
+    @inlinable init(_ character: String.Index, in characters: String) {
+        self.init(character, characters[..<character].count)
+    }
 
     //=--------------------------------------------------------------------=
     // MARK: Comparisons

Sources/DiffableTextKit/Models/Offset.swift

@@ -35,8 +35,7 @@ extension Character: Offset {
     //=------------------------------------------------------------------------=
 
     @inlinable public static func index(at position: Self.Position, in characters: String) -> Index {
-        let character = characters.index(characters.startIndex, offsetBy: position.offset)
-        return Index(character, position.offset)
+        Index(characters.index(characters.startIndex, offsetBy:  position.offset), position.offset)
     }
 
     @inlinable public static func position(at index: Index, in characters: String) -> Self.Position {
@@ -55,8 +54,7 @@ extension UTF16: Offset {
     //=------------------------------------------------------------------------=
 
     @inlinable public static func index(at position: Self.Position, in characters: String) -> Index {
-        let character = String.Index(utf16Offset: position.offset, in: characters)
-        return Index(character, characters[..<character].count)
+        Index(String.Index(utf16Offset: position.offset, in: characters), in:  characters)
     }
 
     @inlinable public static func position(at index: Index, in characters: String) -> Self.Position {