Why
The "Documenting impossible states" example uses emojiMap.get(symbol) — a Map API call on a nonexistent variable — while the real code uses plain object bracket access on a variable named emojiLabel, so the snippet is factually wrong and will not compile.
Current state
utils/errors/README.invariant.md line 36:
const ariaLabel = emojiMap.get(symbol)
invariant(ariaLabel, 'Emoji must have aria-label', { symbol })
// Documents that our emoji map should be completeui/elements/emoji.tsx declares const emojiLabel = { … } as const and accesses it as const ariaLabel = emojiLabel[symbol]. There is no emojiMap variable and no .get() call anywhere in that file.
Ideal state
- The example matches the actual code:
const ariaLabel = emojiLabel[symbol].
- A reader can copy the snippet and have it reflect what the codebase actually does.
Starting points
utils/errors/README.invariant.md — line 36, the "Documenting impossible states" exampleui/elements/emoji.tsx — line 3 (const emojiLabel), line 30 (emojiLabel[symbol])
QA plan
- Open
utils/errors/README.invariant.md and read the "Documenting impossible states" example — expect emojiLabel[symbol] (plain object bracket access, correct variable name).
- Open
ui/elements/emoji.tsx — expect the same expression on line 30.
Done when
The "Documenting impossible states" example uses emojiLabel[symbol], matching the real variable name and access pattern in ui/elements/emoji.tsx.
Why
The "Documenting impossible states" example uses
emojiMap.get(symbol)— aMapAPI call on a nonexistent variable — while the real code uses plain object bracket access on a variable namedemojiLabel, so the snippet is factually wrong and will not compile.Current state
utils/errors/README.invariant.mdline 36:ui/elements/emoji.tsxdeclaresconst emojiLabel = { … } as constand accesses it asconst ariaLabel = emojiLabel[symbol]. There is noemojiMapvariable and no.get()call anywhere in that file.Ideal state
const ariaLabel = emojiLabel[symbol].Starting points
utils/errors/README.invariant.md— line 36, the "Documenting impossible states" exampleui/elements/emoji.tsx— line 3 (const emojiLabel), line 30 (emojiLabel[symbol])QA plan
utils/errors/README.invariant.mdand read the "Documenting impossible states" example — expectemojiLabel[symbol](plain object bracket access, correct variable name).ui/elements/emoji.tsx— expect the same expression on line 30.Done when
The "Documenting impossible states" example uses
emojiLabel[symbol], matching the real variable name and access pattern inui/elements/emoji.tsx.