docs: add clarification for longer_alt chaining

fixes #1334
Chevrotain · Feb 25, 2021 · 5a50819 · 5a50819
1 parent 7d2bb11
commit 5a50819
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/packages/chevrotain/api.d.ts b/packages/chevrotain/api.d.ts
@@ -1535,6 +1535,8 @@ export interface ITokenConfig {
    * This feature can be useful when two Token Types have common prefixes which
    * cannot be resolved (only) by the ordering of the Tokens in the lexer definition.
    *
+   * - Note that the `longer_alt` capability is **cannot be chained**, only a single longer_alt will be checked for a specific Token.
+   *
    * For example see: https://github.com/chevrotain/chevrotain/tree/master/examples/lexer/keywords_vs_identifiers
    * For resolving the keywords vs Identifier ambiguity.
    */

diff --git a/packages/chevrotain/docs/features/token_alternative_matches.md b/packages/chevrotain/docs/features/token_alternative_matches.md
@@ -20,5 +20,7 @@ const ClassKeyword = createToken({
 })
 ```
 
+Note that the `longer_alt` capability is **cannot be chained**, only a single longer_alt will be checked for a specific Token.
+
 See [executable example](https://github.com/chevrotain/chevrotain/tree/master/examples/lexer/keywords_vs_identifiers)
 for further details.