Update documentation

Author: danielsaidi

Sources/RichTextKit/Actions/RichTextAction+Button.swift

@@ -12,8 +12,8 @@ public extension RichTextAction {
 
     /// This view can be used to trigger a ``RichTextAction``.
     ///
-    /// It renders a plain `Button`, which means you can use
-    /// and configure it as a normal button.
+    /// This view is rendered as a plain SwiftUI `Button`, so you can use and
+    /// configure it just like a regular button.
     struct Button: View {
 
         /// Create a rich text action button.

Sources/RichTextKit/Actions/RichTextAction+ButtonGroup.swift

@@ -13,8 +13,8 @@ public extension RichTextAction {
 
     /// This view adds ``RichTextAction`` buttons to a group.
     ///
-    /// Since the view will bind to multiple values, it uses
-    /// a ``RichTextContext`` instead of individual values.
+    /// Since this view binds to multiple values, it uses a ``RichTextContext``
+    /// instead of individual values.
     struct ButtonGroup: View {
 
         /// Create a rich text action button stack.

Sources/RichTextKit/Actions/RichTextAction+ButtonStack.swift

@@ -12,8 +12,8 @@ public extension RichTextAction {
 
     /// This view adds ``RichTextAction`` buttons to a stack.
     ///
-    /// Since the view will bind to multiple values, it uses
-    /// a ``RichTextContext`` instead of individual values.
+    /// Since this view binds to multiple values, it uses a ``RichTextContext``
+    /// instead of individual values. 
     struct ButtonStack: View {
 
         /// Create a rich text action button stack.

Sources/RichTextKit/Actions/RichTextAction+KeyboardShortcutModifier.swift

@@ -10,8 +10,7 @@ import SwiftUI
 
 public extension RichTextAction {
 
-    /// Apply keyboard shortcuts for a ``RichTextAction`` to
-    /// the view.
+    /// Apply keyboard shortcuts for a ``RichTextAction`` to the view.
     ///
     /// You can also use ``SwiftUICore/View/keyboardShortcut(for:)-9i7js``.
     struct KeyboardShortcutModifier: ViewModifier {
@@ -30,8 +29,7 @@ public extension RichTextAction {
 
 public extension View {
 
-    /// Apply keyboard shortcuts for a ``RichTextAction`` to
-    /// the view.
+    /// Apply keyboard shortcuts for a ``RichTextAction`` to the view.
     @ViewBuilder
     func keyboardShortcut(for action: RichTextAction) -> some View {
         #if iOS || macOS || os(visionOS)

Sources/RichTextKit/Actions/RichTextAction.swift

@@ -9,11 +9,9 @@
 import SwiftUI
 import Combine
 
-/// This enum defines rich text actions that can be executed
-/// on a rich text editor.
+/// This enum defines rich text actions that can be executed on a rich text editor.
 ///
-/// It's also a namespace for action-related types and views,
-/// like ``RichTextAction/Button``.
+/// It's also a namespace for action-related types, like ``RichTextAction/Button``.
 public enum RichTextAction: Identifiable, Equatable, RichTextLabelValue {
 
     /// Copy the currently selected text, if any.

Sources/RichTextKit/Actions/RichTextInsertion.swift

@@ -7,17 +7,15 @@
 
 import Foundation
 
-/// This protocol can be implemented by anything that can be
-/// inserted into a rich text.
+/// This protocol can be implemented by types that can be inserted into a rich text.
 public protocol RichTextInsertable: Hashable, Equatable {}
 
 extension String: RichTextInsertable {}
 extension ImageRepresentable: RichTextInsertable {}
 extension [ImageRepresentable]: RichTextInsertable {}
 extension NSAttributedString: RichTextInsertable {}
 
-/// This struct represents something that should be inserted
-/// into a rich text attributed string.
+/// This struct represents something that should be inserted into a rich text.
 public struct RichTextInsertion<T: RichTextInsertable>: Hashable, Equatable {
 
     /// Create a rich text insertion.

Sources/RichTextKit/Attributes/RichTextAttribute.swift

@@ -11,6 +11,5 @@ import Foundation
 /// This typealias represents a rich text dictionary key.
 public typealias RichTextAttribute = NSAttributedString.Key
 
-/// This typealias represents a dictionary with an attribute
-/// as key and `Any` as value.
+/// This typealias represents a dictionary with an attribute key and `Any` value.
 public typealias RichTextAttributes = [RichTextAttribute: Any]

Sources/RichTextKit/Attributes/RichTextAttributeReader.swift

@@ -8,18 +8,15 @@
 
 import Foundation
 
-/// This protocol extends the ``RichTextReader`` protocol to
-/// make any implementing type able to get attributes in the
-/// ``RichTextReader/richText`` property.
+/// This protocol extends the ``RichTextReader`` protocol to make any type
+/// that implements it able to get ``RichTextReader/richText`` attributes.
 ///
-/// This protocol is implemented by `NSAttributedString` and
-/// other types in the library.
+/// The protocol is implemented by `NSAttributedString` and other types in
+/// the library.
 ///
-/// > Note: The protocol used to have a lot of functionality
-/// for getting various attributes, styles, etc. However, it
-/// caused duplicated code since the ``RichTextViewComponent``
-/// needed more capabilities as well. As such, this protocol
-/// is now limited in functionality.
+/// > Note: This protocol used to have a lot of functionality. This caused duplicated
+/// code since the ``RichTextViewComponent`` needed to do more. As such,
+/// this protocol is now limited in functionality.
 public protocol RichTextAttributeReader: RichTextReader {}
 
 extension NSAttributedString: RichTextAttributeReader {}

Sources/RichTextKit/Attributes/RichTextAttributeWriter.swift

@@ -8,18 +8,15 @@
 
 import Foundation
 
-/// This protocol extends the ``RichTextWriter`` protocol to
-/// make any implementing type able to set attributes in the
-/// ``RichTextReader/richText`` property.
+/// This protocol extends the ``RichTextWriter`` protocol to make any type
+/// that implements it able to set ``RichTextReader/richText`` attributes.
 ///
-/// This protocol is implemented by `NSAttributedString` and
-/// other types in the library.
+/// This protocol is implemented by `NSAttributedString` and other types in
+/// the library.
 ///
-/// > Note: The protocol used to have a lot of functionality
-/// for getting various attributes, styles, etc. However, it
-/// caused duplicated code since the ``RichTextViewComponent``
-/// needed more capabilities as well. As such, this protocol
-/// is now limited in functionality.
+/// > Note: This protocol used to have a lot of functionality. This caused duplicated
+/// code since the ``RichTextViewComponent`` needed to do more. As such,
+/// this protocol is now limited in functionality.
 public protocol RichTextAttributeWriter: RichTextWriter, RichTextAttributeReader {}
 
 extension NSMutableAttributedString: RichTextAttributeWriter {}

Sources/RichTextKit/Bridging/RichTextViewComponent+Font.swift

@@ -6,21 +6,18 @@
 //  Copyright © 2022-2024 Daniel Saidi. All rights reserved.
 //
 
-/// These functions may seem complicated, but it is the only
-/// way that seems to work correctly, so far.
+/// These functions may seem complicated, but it's the only way that work, so far.
 ///
-/// I previously grabbed the `typingAttributes` and took the
-/// `.font` attribute from it, then took its `fontDescriptor`
-/// and created a new font with `withFamily`, then created a
-/// new font with the new descriptor and old size.
+/// I previously grabbed the `typingAttributes` and its `.font` attribute,
+/// then used its `fontDescriptor` to create a new font with `withFamily`,
+/// then created a new font with the new descriptor and old size.
 ///
-/// That approach however fails since the San Francisco font
-/// specifies a certain usage, that casuses the font name to
-/// not apply. This code just creates a new font instead, so
-/// be aware if something doesn't work as expected.
+/// That approach however fails since the San Francisco font specifies a certain
+/// usage, that casuses the font name to not apply. This code creates a new font
+/// instead, so be aware if something doesn't work as expected.
 ///
-/// After removing the ``RichTextAttributeWriter`` in 1.0 we
-/// can hopefully iterate more consistently on the extension.
+/// After removing the ``RichTextAttributeWriter`` in 1.0 we can iterate
+/// more consistently on the extension.
 
 import CoreGraphics
 import Foundation