Fix wrong variable name and path in README.invariant.md "Documenting Complete Mapping" example#82
Merged
Merged
Conversation
Code ReviewOverviewThis PR fixes two typos/inaccuracies in a documentation code example inside
Both corrections are verified against the actual codebase in the PR description's validation checklist. Code Quality and Style
Correctness
Potential IssuesNone. The change is documentation-only with no runtime impact. SuggestionsNo changes needed. The fix is accurate and complete. Verdict: LGTM. Small, correct, and well-described. Ready to merge. |
There was a problem hiding this comment.
Pull request overview
This PR fixes a documentation example in utils/errors/README.invariant.md so it matches the actual emoji mapping implementation used by the UI, preventing copy/paste errors from the README.
Changes:
- Corrects the example variable from
emojiLabelstoemojiLabelto match the real identifier. - Updates the referenced file path in the example comment to
ui/elements/emoji.tsx.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
emojiLabels[symbol]toemojiLabel[symbol]in the "Documenting Complete Mapping" code block — the real variable is singular, no trailingsui/emoji.tsxtoui/elements/emoji.tsxto match the actual file locationWhy
emojiLabelsdoes not exist in the codebaseHow to validate
utils/errors/README.invariant.mdand read the "Documenting Complete Mapping" block — expectemojiLabel[symbol](singular) and path comment// ui/elements/emoji.tsxui/elements/emoji.tsx— expectconst emojiLabelon line 3 andemojiLabel[symbol]on line 30, matching the exampleCloses #31
Related links
Generated by Claude Code