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;