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

chore: remove repetitive words #1566

Merged
merged 3 commits into from
Sep 5, 2024
Merged

Conversation

longhutianjie
Copy link
Contributor

@longhutianjie longhutianjie commented Sep 3, 2024

remove repetitive 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
    • Updated the JSON-RPC API documentation for the blockhash parameter to use consistent capitalization as "blockHash."
    • Corrected the description in the OpenAPI specification by removing redundant wording for the "validators" field.

@longhutianjie longhutianjie requested a review from a team as a code owner September 3, 2024 14:55
@longhutianjie longhutianjie requested review from yihuang and mmsqe and removed request for a team September 3, 2024 14:55
Copy link
Contributor

coderabbitai bot commented Sep 3, 2024

Walkthrough

The changes involve minor updates to documentation files related to the JSON-RPC API and OpenAPI specification. Specifically, the capitalization of the blockhash parameter was corrected to blockHash, and a redundant word was removed from the description of the "validators" field. These adjustments enhance clarity and consistency in the documentation without affecting the API's functionality.

Changes

Files Change Summary
docs/api/json-rpc/endpoints.md Updated blockhash to blockHash for consistency in parameter naming conventions.
docs/static/openapi.yml Removed redundant "the" from the description of the "validators" field for clarity.

Poem

In the meadow, changes bloom,
With words that dance and gently loom.
BlockHash shines, so clear and bright,
Validators' tales take flight!
A hop, a skip, in the docs we cheer,
For clarity's joy is finally here! 🐇✨


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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 5ad26ac and c5cf3a3.

Files selected for processing (2)
  • docs/api/json-rpc/endpoints.md (1 hunks)
  • docs/static/openapi.yml (2 hunks)
Files skipped from review due to trivial changes (2)
  • docs/api/json-rpc/endpoints.md
  • docs/static/openapi.yml

@yihuang
Copy link
Collaborator

yihuang commented Sep 4, 2024

@longhutianjie can you sign the commit?

Signed-off-by: longhutianjie <git@before.tech>
@longhutianjie
Copy link
Contributor Author

@longhutianjie can you sign the commit?

Thanks Signed

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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between c5cf3a3 and 00c1941.

Files selected for processing (2)
  • docs/api/json-rpc/endpoints.md (1 hunks)
  • docs/static/openapi.yml (2 hunks)
Files skipped from review due to trivial changes (1)
  • docs/api/json-rpc/endpoints.md
Files skipped from review as they are similar to previous changes (1)
  • docs/static/openapi.yml

Copy link

codecov bot commented Sep 4, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 15.24%. Comparing base (90d0698) to head (92250a6).
Report is 1 commits behind head on main.

❗ There is a different number of reports uploaded between BASE (90d0698) and HEAD (92250a6). Click for more details.

HEAD has 11 uploads less than BASE
Flag BASE (90d0698) HEAD (92250a6)
2 0
integration_tests 19 10
Additional details and impacted files

Impacted file tree graph

@@             Coverage Diff             @@
##             main    #1566       +/-   ##
===========================================
- Coverage   36.12%   15.24%   -20.89%     
===========================================
  Files          97       67       -30     
  Lines        7725     4874     -2851     
===========================================
- Hits         2791      743     -2048     
+ Misses       4585     4037      -548     
+ Partials      349       94      -255     

see 47 files with indirect coverage changes

@yihuang yihuang added this pull request to the merge queue Sep 5, 2024
Merged via the queue into crypto-org-chain:main with commit 13360a7 Sep 5, 2024
32 of 34 checks passed
@Sajjon
Copy link

Sajjon commented Sep 9, 2024

@yihuang

Caution

GH user longhutianjie is performing a supply chain attack!
🚫 BLOCK user immediatly and report him to Github 🚫

The first step is getting rid of "first time contributor" status.

The user has manually added the message "Signed-off-by: " to make the commit
look more trust worthy. User has opened similar PRs in all these other
repos in within the same hour:

Furthermore I'm pretty sure this is the same person or group as github.com/vivoxfold3,
who tried performing the attack against these repos, with the exact same style:
Manually adding the message "Signed-off-by: " and making trivial contributions
to many crypto libs within the same hour:

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.

4 participants