Skip to content

Commit c06b826

Browse files
committed
Cleanup: environment method comments.
1 parent 4c33639 commit c06b826

File tree

4 files changed

+6
-5
lines changed

4 files changed

+6
-5
lines changed

Sources/DiffableTextKitXUIKit/Environment+AutocorrectionDisabled.swift

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ extension EnvironmentValues {
3939

4040
public extension View {
4141

42-
/// Sets whether to disable autocorrection for diffable text views.
42+
/// Optionally disables autocorrection in diffable text views.
4343
///
4444
/// It is similar to `View/autocorrectionDisabled(_:)`.
4545
///
@@ -52,6 +52,7 @@ public extension View {
5252
///
5353
/// - The default value is `false`.
5454
/// - This method was added for consistency.
55+
/// - This method does not affect style autocorrection behavior.
5556
///
5657
@inlinable func diffableTextViews_autocorrectionDisabled(_ disabled: Bool = true) -> some View {
5758
self.environment(\.diffableTextViews_autocorrectionDisabled, disabled)

Sources/DiffableTextKitXUIKit/Environment+MultilineTextAlignment.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ extension EnvironmentValues {
3939

4040
public extension View {
4141

42-
/// Sets the alignment of text a diffable text view.
42+
/// Sets the alignment of text in diffable text views.
4343
///
4444
/// It is similar to `View/multilineTextAlignment(_:)`.
4545
///

Sources/DiffableTextKitXUIKit/Environment+TextInputAutocapitalization.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ extension EnvironmentValues {
3939

4040
public extension View {
4141

42-
/// Sets how often the shift key in the keyboard is automatically enabled.
42+
/// Sets how often the shift key automatically enabled in diffable text views.
4343
///
4444
/// It is similar to `View/textInputAutocapitalization(_:)`.
4545
///

Sources/DiffableTextKitXUIKit/Environment+ToolbarDoneButton.swift

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ extension EnvironmentValues {
4040

4141
public extension View {
4242

43-
/// Adds a toolbar done button for convenient dismissal.
43+
/// Adds a toolbar with a done button for convenient dismissal.
4444
///
4545
/// Instructs the view to install a toolbar similar to SwiftUI's
4646
///
@@ -57,7 +57,7 @@ public extension View {
5757
///
5858
/// **Notes**
5959
///
60-
/// - The default value is `nil`.
60+
/// - The default value is `nil` (no toolbar installed).
6161
/// - The `SwiftUI/toolbar` environment value is inaccessible.
6262
///
6363
@inlinable func diffableTextViews_toolbarDoneButton(_ style: UIBarButtonItem.Style = .plain) -> some View {

0 commit comments

Comments
 (0)