Add warning about issue #112.

apache · Jul 9, 2021 · 6475023 · 6475023
1 parent 32f9fda
commit 6475023
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 0 deletions.
diff --git a/packages/dom/src/text-quote/match.ts b/packages/dom/src/text-quote/match.ts
@@ -40,6 +40,10 @@ import { TextNodeChunker, EmptyScopeError } from '../text-node-chunker';
  * return an (async) generator that produces each match in the order they are
  * found in the text.
  *
+ * *XXX Modifying the DOM (e.g. to highlight the text) while the search is still
+ * running can mess up and result in an error or an infinite loop. See [issue
+ * #112](https://github.com/apache/incubator-annotator/issues/112).*
+ *
  * @example
  * ```
  * // Find the word ‘banana’.

diff --git a/packages/selector/src/text/match-text-quote.ts b/packages/selector/src/text/match-text-quote.ts
@@ -45,6 +45,9 @@ import type { Chunk, Chunker, ChunkRange } from './chunker';
  * return an (async) generator that produces each match in the order they are
  * found in the text.
  *
+ * *XXX Modifying the Chunks while the search is still running can mess up and
+ * result in an error or an infinite loop. See [issue #112](https://github.com/apache/incubator-annotator/issues/112).*
+ *
  * @example
  * ```
  * const selector = { type: 'TextQuoteSelector', exact: 'banana' };