dev: comment on RealtimeQuery.remoteDocChanges$ (#3482)

marksvc · web-flow · commit 253347a3ee27 · 2025-09-30T22:47:19.000Z
diff --git a/src/SIL.XForge.Scripture/ClientApp/src/xforge-common/models/realtime-query.ts b/src/SIL.XForge.Scripture/ClientApp/src/xforge-common/models/realtime-query.ts
@@ -72,6 +72,10 @@ export class RealtimeQuery<T extends RealtimeDoc = RealtimeDoc> {
     return this._ready$;
   }
 
+  /** Emitted when a document in the query results is changed remotely. Note that because remote document changes, and
+   * remote query results changes, are not announced or applied in sync, `docs` might not be up-to-date when
+   * `remoteDocChanges$` is emitted.
+   */
   get remoteDocChanges$(): Observable<any> {
     return this._remoteDocChanges$.asObservable();
   }

Original file line number	Diff line number	Diff line change
`@@ -72,6 +72,10 @@ export class RealtimeQuery<T extends RealtimeDoc = RealtimeDoc> {`
`72`	`72`	`return this._ready$;`
`73`	`73`	`}`
`74`	`74`
	`75`	`+ /** Emitted when a document in the query results is changed remotely. Note that because remote document changes, and`
	`76`	+ * remote query results changes, are not announced or applied in sync, `docs` might not be up-to-date when
	`77`	+ * `remoteDocChanges$` is emitted.
	`78`	`+ */`
`75`	`79`	`get remoteDocChanges$(): Observable<any> {`
`76`	`80`	`return this._remoteDocChanges$.asObservable();`
`77`	`81`	`}`