From 6de595394bf2ea95779728058df3b2778be69fbd Mon Sep 17 00:00:00 2001
From: "Joshua A. Horton" <joshua_horton@sil.org>
Date: Thu, 14 Mar 2024 21:47:51 +0700
Subject: [PATCH] docs(common/models/templates): a bit more for traversal
 `child` method

---
 common/models/types/index.d.ts | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/common/models/types/index.d.ts b/common/models/types/index.d.ts
index 9b1f2de9d9..e94d758b0b 100644
--- a/common/models/types/index.d.ts
+++ b/common/models/types/index.d.ts
@@ -59,6 +59,10 @@ declare interface LexiconTraversal {
    * If such a traversal state is not supported, returns `undefined`.
    * Implementations may choose to return `undefined` if more than one UTF-16
    * codepoint is appended, even if such a descendant exists.
+   *
+   * Note: traversals navigate and represent the lexicon in its "keyed" state,
+   * as produced by use of the search-term keying function defined for the model.
+   * That is, if a model "keys" `è` to `e`, there will be no `è` child.
    * @param char
    */
   child(char: USVString): LexiconTraversal | undefined;