docs(writing-skills): add character-safety guidance for inline exclamation parsing#637
Conversation
📝 WalkthroughWalkthroughAdded a "Character Safety Gotcha (Claude Code parser bug)" subsection to the writing-skills guide documenting that exclamation marks in inline code spans cause parser failures. Includes three workarounds and references to related open issues. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
🧹 Nitpick comments (1)
skills/writing-skills/SKILL.md (1)
353-354: Consider clarifying why spelled-out text in backticks is safe.The first workaround demonstrates
exclamation-equalsin backticks, which might momentarily confuse readers who just read "Never put exclamation marks inside single-backtick inline code spans." While the distinction is clear to careful readers (spelled-out text contains no!character), making this explicit would prevent any misunderstanding.✨ Proposed clarity improvement
Workarounds: -- Spell operators out in prose (`exclamation-equals`, `exclamation-tilde`) instead of writing symbols inline +- Spell operators out in prose (e.g., `exclamation-equals`, `exclamation-tilde`) instead of using the actual `!` character in backticks - Put exact syntax in fenced code blocks when needed🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@skills/writing-skills/SKILL.md` around lines 353 - 354, Add a short clarifying sentence after the workaround that explains why spelled-out operators in single-backtick inline code (e.g., `exclamation-equals`, `exclamation-tilde`) are safe: explicitly state that the spelled-out text contains no literal `!` character so it does not trigger the warning "Never put exclamation marks inside single-backtick inline code spans." Update the line listing the workarounds to include this brief note so readers immediately understand the distinction.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@skills/writing-skills/SKILL.md`:
- Around line 353-354: Add a short clarifying sentence after the workaround that
explains why spelled-out operators in single-backtick inline code (e.g.,
`exclamation-equals`, `exclamation-tilde`) are safe: explicitly state that the
spelled-out text contains no literal `!` character so it does not trigger the
warning "Never put exclamation marks inside single-backtick inline code spans."
Update the line listing the workarounds to include this brief note so readers
immediately understand the distinction.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository UI
Review profile: CHILL
Plan: Pro
Run ID: 5d24e7ad-2197-4828-8825-ad99264f1ee9
📒 Files selected for processing (1)
skills/writing-skills/SKILL.md
Summary
skills/writing-skills/SKILL.mdVerification
bash tests/opencode/test-skills-core.shskills/writing-skills/SKILL.mdcontain exclamation marksCloses #451