docs(store): clarify behavior of checkoutPair

sanity-io · Feb 4, 2025 · 4740c2c · 4740c2c
1 parent 0a8ef89
commit 4740c2c
Showing 1 changed file with 7 additions and 1 deletion.
diff --git a/packages/sanity/src/core/store/_legacy/document/document-store.ts b/packages/sanity/src/core/store/_legacy/document/document-store.ts
@@ -52,7 +52,13 @@ function getIdPairFromPublished(publishedId: string, version?: string): IdPair {
  * @hidden
  * @beta */
 export interface DocumentStore {
-  /** @internal */
+  /**
+   * Checks out a document (with its published and draft version) for real-time editing.
+   * Note that every call to this function will open a new listener to the server.
+   * It's recommended to use the helper functions on `pair` below which will re-use a single connection.
+   *
+   * @internal
+   **/
   checkoutPair: (idPair: IdPair) => Pair
   initialValue: (
     opts: InitialValueOptions,