Skip to content
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

docs: fix variable name and remove extra parens #264

Merged
merged 1 commit into from
Mar 19, 2025

Conversation

mutewinter
Copy link
Contributor

@mutewinter mutewinter commented Mar 18, 2025

Loving the library. Just some small typos I noticed while reading the docs.

Summary by CodeRabbit

  • Documentation
    • Refined error handling examples to improve clarity in illustrating error construction.
    • Updated middleware integration instructions to reflect current setup conventions without altering underlying functionality.

Copy link

vercel bot commented Mar 18, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
orpc ✅ Ready (Inspect) Visit Preview 💬 Add feedback Mar 18, 2025 6:44pm

Copy link

coderabbitai bot commented Mar 18, 2025

Walkthrough

The changes update two documentation files. In the error-handling documentation, the syntax for throwing an ORPCError is modified by removing the extra parentheses around the error object literal. In the Hono integrations documentation, the argument passed to the createMiddleware function is updated from rpcHandler to handler, reflecting a variable renaming in the RPC middleware setup. No changes were made to the public entity declarations.

Changes

File(s) Change Summary
apps/.../docs/error-handling.md Changed error throwing syntax by replacing parentheses encapsulation with direct use of curly braces for the error object.
apps/.../docs/integrations/hono.md Updated the argument in the createMiddleware call from rpcHandler to handler in the middleware configuration.

Poem

In fields of code I joyously leap,
Dropping old wraps, my errors now clean and deep,
With curly braces shining in the moonlit night,
And a handler renamed to set things right,
I hop and celebrate each change in sight,
A coding rabbit's cheer under starlight! 🐇

Tip

⚡🧪 Multi-step agentic review comment chat (experimental)
  • We're introducing multi-step agentic chat in review comments. This experimental feature enhances review discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments.
    - To enable this feature, set early_access to true under in the settings.

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4fc998d and 48a7e73.

📒 Files selected for processing (2)
  • apps/content/docs/error-handling.md (2 hunks)
  • apps/content/docs/integrations/hono.md (1 hunks)
🔇 Additional comments (3)
apps/content/docs/integrations/hono.md (1)

18-20: Variable Name Update in Middleware Setup
The change updates the argument passed to createMiddleware from a previously used rpcHandler to the clearly declared handler. This improves consistency in the documentation. Ensure that the referenced router is defined in the broader context or example.

apps/content/docs/error-handling.md (2)

29-35: Streamlined ORPCError Instantiation in Normal Approach
The removal of the extra parentheses around the error object in the ORPCError constructor call enhances readability and aligns with standard JavaScript syntax.


112-115: Consistent Error Handling Syntax Correction
Removing the unnecessary parentheses in the second instance of ORPCError instantiation maintains consistency across the documentation examples, making the error-handling code clearer to readers.


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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

codecov bot commented Mar 19, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

📢 Thoughts on this report? Let us know!

Copy link

pkg-pr-new bot commented Mar 19, 2025

Open in Stackblitz

More templates

@orpc/arktype

npm i https://pkg.pr.new/@orpc/arktype@264

@orpc/client

npm i https://pkg.pr.new/@orpc/client@264

@orpc/openapi

npm i https://pkg.pr.new/@orpc/openapi@264

@orpc/contract

npm i https://pkg.pr.new/@orpc/contract@264

@orpc/openapi-client

npm i https://pkg.pr.new/@orpc/openapi-client@264

@orpc/react-query

npm i https://pkg.pr.new/@orpc/react-query@264

@orpc/server

npm i https://pkg.pr.new/@orpc/server@264

@orpc/shared

npm i https://pkg.pr.new/@orpc/shared@264

@orpc/solid-query

npm i https://pkg.pr.new/@orpc/solid-query@264

@orpc/standard-server

npm i https://pkg.pr.new/@orpc/standard-server@264

@orpc/standard-server-fetch

npm i https://pkg.pr.new/@orpc/standard-server-fetch@264

@orpc/standard-server-node

npm i https://pkg.pr.new/@orpc/standard-server-node@264

@orpc/svelte-query

npm i https://pkg.pr.new/@orpc/svelte-query@264

@orpc/valibot

npm i https://pkg.pr.new/@orpc/valibot@264

@orpc/vue-colada

npm i https://pkg.pr.new/@orpc/vue-colada@264

@orpc/vue-query

npm i https://pkg.pr.new/@orpc/vue-query@264

@orpc/zod

npm i https://pkg.pr.new/@orpc/zod@264

commit: 48a7e73

@unnoq
Copy link
Owner

unnoq commented Mar 19, 2025

Thank @mutewinter

@unnoq unnoq merged commit 8900489 into unnoq:main Mar 19, 2025
8 checks passed
@mutewinter mutewinter deleted the docs-small-fixes branch March 19, 2025 13:42
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.

2 participants