-
Notifications
You must be signed in to change notification settings - Fork 457
docs: Minor grammatical/rephrasing changes to Express migration doc #753
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
Minor grammatical changes throughout the doc for better clarity and readability
WalkthroughThis PR makes editorial corrections to the Express migration guide documentation, adjusting grammar, spelling, hyphenation, and terminology without changing code or behavior. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes
Possibly related PRs
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
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: 1
🧹 Nitpick comments (2)
docs/migrate/from-express.md (2)
848-848: Hyphenate "route-specific" as a compound adjective.Line 848 uses "route specific error handler" which should use a hyphen since it's a compound adjective modifying "error handler".
Apply this diff:
-2. Shorthand for mapping HTTP status and `toResponse` for mapping error to a response -3. Custom error code for each error +2. Shorthand for mapping HTTP status and `toResponse` for mapping error to a response +3. Custom error code for each errorMore specifically, the text "route specific error handler" should be "route-specific error handler":
-1. Both global and route specific error handler +1. Both global and route-specific error handler
1153-1154: Reduce repetition of "Elysia" at the start of consecutive sentences.Lines 1153–1154 contain three consecutive sentences that each begin with "Elysia", creating repetitive phrasing. This detracts from readability.
Consider rewording to vary sentence openers:
-Elysia will generate an OpenAPI specification based on the schema you provided, and validate the request and response based on the schema, and infer types automatically. +Elysia generates an OpenAPI specification based on the schema you provided, validates the request and response, and infers types automatically. Elysia also appends the schema registered in `model` to the OpenAPI spec, allowing you to reference the model in a dedicated section in Swagger or Scalar UI.Alternatively:
-Elysia will generate an OpenAPI specification based on the schema you provided, and validate the request and response based on the schema, and infer types automatically. +Based on the schema you provided, Elysia generates an OpenAPI specification, validates requests and responses, and infers types automatically. Additionally, Elysia appends the schema registered in `model` to the OpenAPI spec, allowing you to reference the model in a dedicated section in Swagger or Scalar UI.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/migrate/from-express.md(25 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/migrate/from-express.md
[grammar] ~114-~114: Ensure spelling is correct
Context: ...Handler Both Express and Elysia have a simliar property for accessing input parameters...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~848-~848: Use a hyphen to join words.
Context: ...ysia provides: 1. Both global and route specific error handler 2. Shorthand for ...
(QB_NEW_EN_HYPHEN)
[style] ~1154-~1154: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...schema, and infer types automatically. Elysia also appends the schema registered in `...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
🔇 Additional comments (1)
docs/migrate/from-express.md (1)
1-1310: Overall: Strong editorial improvements for clarity and readability.The PR successfully addresses numerous grammar, spelling, and wording issues throughout the Express migration guide. Changes like correcting "use" to "uses," improving hyphenation ("sub-router"), and refining technical descriptions enhance the document's professionalism and clarity. The amendments align well with the stated objective of improving grammar and readability.
Applied grammar and spelling fixes as suggested by coderabbit
Minor grammatical/rephrasing changes throughout the doc for better clarity and readability
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.