From 3e19ece3564c441e98d4e9de90a121f832d93551 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Miguel=20=C3=81ngel=20D=C3=ADaz?= Date: Sun, 2 Feb 2025 11:37:26 +0100 Subject: [PATCH] comments in pr --- Sources/Automerge/Document.swift | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/Sources/Automerge/Document.swift b/Sources/Automerge/Document.swift index 4ba6ed0..268260d 100644 --- a/Sources/Automerge/Document.swift +++ b/Sources/Automerge/Document.swift @@ -582,9 +582,8 @@ public final class Document: @unchecked Sendable { /// Establish a cursor at the position you specify in the list or text object you provide. /// - /// In collaborative applications, maintaining stable cursor positions is crucial. Traditional index-based - /// positions become outdated when you or collaborators modify the document. This method provides a stable reference to a character that stays - /// correctly anchored regardless of changes. + /// Traditional index-based positions become outdated when you or collaborators modify the document. + /// This method provides a stable reference to a character that stays correctly anchored regardless of changes. /// /// `Cursor` provides a reliable way to track the position of a character's location over time regardless of document changes. /// The cursor remains anchored to the following character, and if placed at the end of the document, @@ -620,9 +619,8 @@ public final class Document: @unchecked Sendable { /// Establish a cursor at the position and point of time you specify in the list or text object you provide. /// - /// In collaborative applications, maintaining stable cursor positions is crucial. Traditional index-based - /// positions can become outdated due to document modifications. This method ensures the cursor stays - /// correctly anchored regardless of changes. + /// Traditional index-based positions become outdated when you or collaborators modify the document. + /// This method provides a stable reference to a character that stays correctly anchored regardless of changes. /// /// `Cursor` provides a reliable way to track positions over time without being affected by document changes. /// The cursor remains anchored to the following character, and if placed at the end of the document, @@ -958,6 +956,7 @@ public final class Document: @unchecked Sendable { /// ``` /// /// ## Recommendation + /// /// Use this method to query the marks applied to a text object at a specific position. /// This can be useful for retrieving the list of ``Automerge/Mark`` related to a character without /// traversing the full document.