Update docs

matrix-org · Oct 27, 2023 · b76d69c · b76d69c
1 parent 526467c
commit b76d69c
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 4 deletions.
diff --git a/...ser/Sources/WysiwygComposer/Components/WysiwygComposerView/WysiwygComposerViewModel.swift b/...ser/Sources/WysiwygComposer/Components/WysiwygComposerView/WysiwygComposerViewModel.swift
@@ -65,8 +65,7 @@ public class WysiwygComposerViewModel: WysiwygComposerViewModelProtocol, Observa
     }
 
     /// Whether the composer should take any keyboard input.
-    /// When set to `false`, the underlying text won't change.
-    /// Otherwise `replaceText(range:,replacementText:)` is evaluated.
+    /// When set to `false`, `replaceText(range:,replacementText:)` must return `false` as well.
     public var shouldReplaceText = true
 
     /// Published value for the composer plain text mode.

diff --git a/...ces/WysiwygComposer/Components/WysiwygComposerView/WysiwygComposerViewModelProtocol.swift b/...ces/WysiwygComposer/Components/WysiwygComposerView/WysiwygComposerViewModelProtocol.swift
@@ -28,8 +28,7 @@ public protocol WysiwygComposerViewModelProtocol: AnyObject {
     func updateCompressedHeightIfNeeded()
 
     /// Whether the composer should take any keyboard input.
-    /// When set to `false`, the underlying text won't change.
-    /// Otherwise `replaceText(range:,replacementText:)` is evaluated.
+    /// When set to `false`, `replaceText(range:,replacementText:)` must return `false` as well.
     var shouldReplaceText: Bool { get set }
 
     /// Replace text in the model.