Adjust documentation and linting

danielsaidi · Jan 23, 2024 · 8153a3d · 8153a3d
1 parent cc4e5e4
commit 8153a3d
Show file tree

Hide file tree

Showing 10 changed files with 16 additions and 16 deletions.
diff --git a/Demo/iOS/EditorScreen.swift b/Demo/iOS/EditorScreen.swift
@@ -58,7 +58,7 @@ private extension EditorScreen {
             leadingButtons: {},
             trailingButtons: {}
         ) {
-            var sheet = $0
+            let sheet = $0
             // Uncomment this to show all color pickers
             // sheet.colorPickers = .allCases
             return sheet

diff --git a/Sources/RichTextKit/Attributes/RichTextAttributeWriter+Alignment.swift b/Sources/RichTextKit/Attributes/RichTextAttributeWriter+Alignment.swift
@@ -22,7 +22,7 @@ public extension RichTextAttributeWriter {
     ///
     /// > Todo: Something's currently off with alignment. It
     /// spils over to other paragraphs when moving the input
-    /// cursor and inserting new text. 
+    /// cursor and inserting new text.
     func setRichTextAlignment(
         _ alignment: RichTextAlignment,
         at range: NSRange

diff --git a/Sources/RichTextKit/Colors/RichTextColor.swift b/Sources/RichTextKit/Colors/RichTextColor.swift
@@ -81,6 +81,6 @@ public extension RichTextColor {
 }
 
 public extension Collection where Element == RichTextColor {
-    
+
     static var allCases: [RichTextColor] { Element.allCases }
 }
diff --git a/Sources/RichTextKit/Data/RichTextDataError.swift b/Sources/RichTextKit/Data/RichTextDataError.swift
@@ -11,7 +11,7 @@ import Foundation
 /**
  This enum represents rich text data-related errors.
  */
-enum RichTextDataError: Error {
+public enum RichTextDataError: Error {
 
     case invalidArchivedData(in: Data)
     case invalidPlainTextData(in: Data)

diff --git a/Sources/RichTextKit/Fonts/RichTextFont+Picker.swift b/Sources/RichTextKit/Fonts/RichTextFont+Picker.swift
@@ -12,25 +12,25 @@ public extension RichTextFont {
 
     /**
      This font picker can be used to pick a font from a list.
-     It uses ``RichTextFontPickerFont/all`` as default fonts.
+
+     This picker uses ``RichTextFont/PickerFont/all`` as the
+     default fonts.
 
      This view renders a plain `Picker`, which means you can
      use and configure it in all ways supported by SwiftUI.
 
      Note that macOS will render every font correctly, while
-     iOS will only do it in a wheel/inline picker. Try using
-     ``RichTextFontListPicker``/``RichTextFontForEachPicker``
-     on iOS, if you need a proper list.
+     iOS will only do it in a wheel/inline picker.
      */
     struct Picker: View {
 
         /**
          Create a font picker.
 
          - Parameters:
-         - selection: The selected font name.
-         - fonts: The fonts to display in the list, by default `all`.
-         - fontSize: The font size to use in the list items.
+           - selection: The selected font name.
+           - fonts: The fonts to display in the list, by default `all`.
+           - fontSize: The font size to use in the list items.
          */
         public init(
             selection: Binding<FontName>,

diff --git a/Sources/RichTextKit/Fonts/RichTextFont+PickerFont.swift b/Sources/RichTextKit/Fonts/RichTextFont+PickerFont.swift
@@ -32,7 +32,7 @@ public extension RichTextFont {
      which must have its name adjusted.
 
      To change the display name of a system font, simply set
-     ``RichTextFontPickerFont/standardSystemFontDisplayName``
+     ``RichTextFont/PickerFont/standardSystemFontDisplayName``
      to another value.
 
      To change how fonts are detected by the system, use the

diff --git a/Sources/RichTextKit/Fonts/RichTextFont+SizePicker.swift b/Sources/RichTextKit/Fonts/RichTextFont+SizePicker.swift
@@ -23,7 +23,7 @@ public extension RichTextFont {
 
          - Parameters:
            - selection: The selected font size.
-           - sizes: The sizes to display in the list, by default ``RichTextFontSizePicker/standardFontSizes``.
+           - sizes: The font sizes to display in the list.
          */
         public init(
             selection: Binding<CGFloat>,

diff --git a/Sources/RichTextKit/Fonts/RichTextFont+SizePickerStack.swift b/Sources/RichTextKit/Fonts/RichTextFont+SizePickerStack.swift
@@ -22,7 +22,7 @@ public extension RichTextFont {
 
          - Parameters:
            - context: The context to affect.
-           - values: The sizes to display in the list, by default ``RichTextFontSizePicker/standardFontSizes``.
+           - values: The sizes to display in the list, by default ``RichTextFont/SizePicker/standardFontSizes``.
          */
         public init(
             context: RichTextContext,

diff --git a/Sources/RichTextKit/Styles/RichTextStyle+Button.swift b/Sources/RichTextKit/Styles/RichTextStyle+Button.swift
@@ -121,7 +121,7 @@ struct RichTextStyle_Button_Previews: PreviewProvider {
         var body: some View {
             HStack {
                 Text(isBoldOn.description)
-                
+
                 RichTextStyle.Button(
                     style: .bold,
                     value: $isBoldOn)

diff --git a/Tests/RichTextKitTests/Colors/RichTextColorTests.swift b/Tests/RichTextKitTests/Colors/RichTextColorTests.swift
@@ -10,7 +10,7 @@ import RichTextKit
 import XCTest
 
 final class RichTextColorTests: XCTestCase {
-    
+
     func testAllCasesExcludesUndefined() {
         let colors = RichTextColor.allCases
         let expected: [RichTextColor] = [
-Original file line number
+Diff line change
@@ Expand Up / @@ -81,6 +81,6 @@ public extension RichTextColor { @@
     }
     public extension Collection where Element == RichTextColor {
         static var allCases: [RichTextColor] { Element.allCases }
     }