Skip to content

chore: fix some typos in comment #1794

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

riskrose
Copy link

@riskrose riskrose commented Apr 18, 2025

👮🏻👮🏻👮🏻 !!!! REFERENCE THE PROBLEM YOUR ARE SOLVING IN THE PR TITLE AND DESCRIBE YOUR SOLUTION HERE !!!! DO NOT FORGET !!!! 👮🏻👮🏻👮🏻

PR Checklist:

  • Have you read the CONTRIBUTING.md?
  • Does your PR follow the C4 patch requirements?
  • Have you rebased your work on top of the latest master?
  • Have you checked your code compiles? (make)
  • Have you included tests for any non-trivial functionality?
  • Have you checked your code passes the unit tests? (make test)
  • Have you checked your code formatting is correct? (go fmt)
  • Have you checked your basic code style is fine? (golangci-lint run)
  • If you added any dependencies, have you checked they do not contain any known vulnerabilities? (go list -json -m all | nancy sleuth)
  • If your changes affect the client infrastructure, have you run the integration test?
  • If your changes affect public APIs, does your PR follow the C4 evolution of public contracts?
  • If your code changes public APIs, have you incremented the crate version numbers and documented your changes in the CHANGELOG.md?
  • If you are contributing for the first time, please read the agreement in CONTRIBUTING.md now and add a comment to this pull request stating that your PR is in accordance with the Developer's Certificate of Origin.

Thank you for your code, it's appreciated! :)

fix some typos in comment

Summary by CodeRabbit

  • Documentation
    • Corrected typographical and grammatical errors in various documentation files for improved clarity.
  • Style
    • Fixed minor typos in error messages and comments to enhance readability.

@riskrose riskrose requested a review from a team as a code owner April 18, 2025 08:29
@riskrose riskrose requested review from JayT106 and leejw51crypto and removed request for a team April 18, 2025 08:29
Copy link
Contributor

coderabbitai bot commented Apr 18, 2025

Walkthrough

This update addresses typographical and grammatical errors across documentation, comments, and error message strings in several files. Corrections were made to spelling and grammar in Markdown documentation, Go source code comments, and error messages, without altering any logic, control flow, or exported entities. No functional or technical changes were introduced.

Changes

File(s) Change Summary
docs/gravity-bridge/dev-setup-guide.md Fixed a typo: "messge" corrected to "message" in documentation text.
memiavl/README.md Corrected grammar: "splited" changed to "split" in documentation.
memiavl/snapshot.go Fixed typo in error message: "expcted" corrected to "expected" in OpenSnapshot function.
x/cronos/rpc/api.go Corrected spelling in comments: "addreses" changed to "addresses" in two function comments.

Possibly related PRs

Suggested reviewers

  • mmsqe
  • yihuang
  • leejw51crypto

Poem

A hop and a skip, with a twitch of my nose,
I fixed the typos where the grammar woes rose.
From "messge" to "message," and "splited" to "split,"
Now the docs and the code are perfectly fit!
With every small fix, our code garden grows—
🐇✨
Hoppy days for readable prose!

Tip

⚡💬 Agentic Chat (Pro Plan, General Availability)
  • We're introducing multi-step agentic chat in review comments and issue comments, within and outside of PR's. This feature enhances review and issue discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments and add commits to existing pull requests.

📜 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 0ac7f97 and d18ad6e.

📒 Files selected for processing (4)
  • docs/gravity-bridge/dev-setup-guide.md (1 hunks)
  • memiavl/README.md (1 hunks)
  • memiavl/snapshot.go (1 hunks)
  • x/cronos/rpc/api.go (2 hunks)
🔇 Additional comments (5)
memiavl/README.md (1)

59-59: Typo fix: “splited” → “split”
Good catch correcting “splited” to “split” for grammatical accuracy in the changelog.

docs/gravity-bridge/dev-setup-guide.md (1)

121-121: Typo fix: “messge” → “message”
The spelling of “message” is now correct in the instructions for signing the protobuf.

memiavl/snapshot.go (1)

69-71: Typo fix in error message
Updated “expcted” to “expected” in the metadata size validation error—text accurately reflects the intended word.

x/cronos/rpc/api.go (2)

205-205: Typo fix in comment
Corrected “addreses” to “addresses” in the transaction receipt map field description.


339-339: Typo fix in comment
Corrected “addreses” to “addresses” in the replay block receipt map field description.

✨ Finishing Touches
  • 📝 Generate Docstrings

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.

@riskrose
Copy link
Author

Thanks for your approved.

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