cronos icon indicating copy to clipboard operation
cronos copied to clipboard

chore: remove repeat words

Open fivecut opened this issue 1 year ago • 1 comments

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

remove repeat words

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! :)

Summary by CodeRabbit

  • Documentation
    • Corrected typographical errors in the API documentation for JSON-RPC endpoints and Cronos events specification. These changes clarify the usage of parameters and improve readability.

fivecut avatar Jun 13 '24 06:06 fivecut

Walkthrough

The recent updates make minor but essential corrections in the documentation, specifically fixing typographical errors. The first correction pertains to the blockhash parameter documentation in the Ethereum JSON-RPC API, clarifying the filter usage based on block hash. The second adjustment fixes a duplicated word in the Cosmos SDK Baseapp events documentation, enhancing readability and accuracy.

Changes

File Change Summary
docs/api/json-rpc/endpoints.md Corrected typo in blockhash parameter description for EIP-234 filter usage.
x/cronos/spec/06_events.md Fixed duplicated phrase "the the" in Cosmos SDK Baseapp events documentation.

Poem

Amidst the code, where changes tread,
Clarity, like sunlight, spreads. 🌞
Errors fixed, now shines so bright,
Documentation's pure delight! 📚
Typo-free, we stride anew,
Every word now clear and true. ✨


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 as 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 resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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.

coderabbitai[bot] avatar Jun 13 '24 06:06 coderabbitai[bot]

friendly ping~

fivecut avatar Jul 25 '24 07:07 fivecut

friendly ping~

the new commit need to sign as well ;D

yihuang avatar Jul 25 '24 07:07 yihuang

friendly ping~

the new commit need to sign as well ;D

Thanks. I open a new pr and signed. https://github.com/crypto-org-chain/cronos/pull/1525

fivecut avatar Jul 25 '24 08:07 fivecut