-
Notifications
You must be signed in to change notification settings - Fork 454
fix: correct quote typos in status examples #737
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
- Remove extra trailing quote in teapot example - Remove unnecessary escaped apostrophe in double-quoted string
WalkthroughTwo documentation files receive string literal corrections. The first fixes a mismatched trailing quote in a status message example, and the second updates escaped apostrophes to unescaped apostrophes within example code strings. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ 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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (1)
docs/tutorial/patterns/error-handling/index.md (1)
40-52: ✓ Quote fix is correct; consider using spaces for indentation.The error handler example string is now properly formatted with unescaped apostrophes in the double-quoted string, which is valid TypeScript. However, the indentation uses hard tabs instead of spaces, which violates markdown conventions (MD010).
Replace the hard tab with spaces for markdown compliance:
- .onError(({ code, status }) => { + .onError(({ code, status }) => {(Replace the leading tab with spaces to align with surrounding code indentation.)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
docs/tutorial/getting-started/status-and-headers/index.md(1 hunks)docs/tutorial/patterns/error-handling/index.md(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.18.1)
docs/tutorial/patterns/error-handling/index.md
48-48: Hard tabs
Column: 1
(MD010, no-hard-tabs)
🔇 Additional comments (1)
docs/tutorial/getting-started/status-and-headers/index.md (1)
48-54: ✓ Quote fix is correct.The status example now uses a properly formatted string
"I'm a teapot"with the extra trailing quote removed. The syntax is valid and the example is now accurate.
Fixes two quote-related typos in status function examples:
"I'm a teapot'"→"I'm a teapot")I\'m→I'm)Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.