Skip to content

Conversation

@braden-w
Copy link
Contributor

@braden-w braden-w commented Dec 5, 2025

Fixes two quote-related typos in status function examples:

  • Remove extra trailing quote in teapot example ("I'm a teapot'""I'm a teapot")
  • Remove unnecessary escaped apostrophe in double-quoted string (I\'mI'm)

Summary by CodeRabbit

  • Documentation
    • Fixed string formatting errors in tutorial code examples to ensure proper syntax for HTTP status codes and error handling patterns.

✏️ Tip: You can customize this high-level summary in your review settings.

- Remove extra trailing quote in teapot example
- Remove unnecessary escaped apostrophe in double-quoted string
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Dec 5, 2025

Walkthrough

Two 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

Cohort / File(s) Summary
Documentation String Literal Corrections
docs/tutorial/getting-started/status-and-headers/index.md, docs/tutorial/patterns/error-handling/index.md
Fixed mismatched and escaped quotes in example strings: corrected "I'm a teapot'" to "I'm a teapot" and changed escaped apostrophes ('I'm') to unescaped ('I'm') in example code snippets.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 Hopping through the docs, we found a quote,
A teapot's message was misspelled, note!
Apostrophes freed from escaping chains,
Now examples shine with clearer veins. ✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'fix: correct quote typos in status examples' directly and clearly summarizes the main changes: fixing quote-related typos in status function documentation examples.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Contributor

@coderabbitai coderabbitai bot left a 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

📥 Commits

Reviewing files that changed from the base of the PR and between 5e5da8b and 6d6000c.

📒 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant