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: fix spelling errors #2143

Closed
wants to merge 1 commit into from
Closed

chore: fix spelling errors #2143

wants to merge 1 commit into from

Conversation

github-prbot
Copy link
Contributor

@github-prbot github-prbot commented Aug 13, 2024

This PR fixes typos in the codebase.
Please review it, and merge if everything is fine.
If there are proto changes, run make proto-gen and commit the changes.

Summary by CodeRabbit

  • Documentation
    • Updated documentation for inactive validators to enhance clarity on their role in Interchain Security.
    • Corrected typographical errors in the changelog to improve accuracy and readability.

@github-prbot github-prbot requested a review from a team as a code owner August 13, 2024 12:04
Copy link
Contributor

coderabbitai bot commented Aug 13, 2024

Walkthrough

Walkthrough

The updates refine the documentation regarding inactive validators and their role in Interchain Security. They clarify how validators outside the active set can participate in consumer chain validation without altering the core functionalities. The changes aim to enhance understanding for validators, stakers, and consumer chains about the implications of allowing inactive validators to validate on consumer chains.

Changes

File Path Change Summary
docs/docs/integrators/integrating_inactive_validators.md Improved clarity in the description of inactive validators' functionality and participation on consumer chains, without modifying core technical details.
.changelog/v5.1.1/api-breaking/provider/2095-proto-message-fix.md Corrected a typographical error from "defitions" to "definitions" for clarity in the changelog, with no impact on functionality.
.changelog/v5.1.1/state-breaking/provider/2095-proto-message-fix.md Corrected the spelling of "definitions" in the commit message for the proto files, enhancing documentation accuracy without altering functionality.

Possibly related issues


Recent review details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between d2a40dd and be5160f.

Files ignored due to path filters (1)
  • CHANGELOG.md is excluded by !*.md
Files selected for processing (3)
  • .changelog/v5.1.1/api-breaking/provider/2095-proto-message-fix.md (1 hunks)
  • .changelog/v5.1.1/state-breaking/provider/2095-proto-message-fix.md (1 hunks)
  • docs/docs/integrators/integrating_inactive_validators.md (1 hunks)
Files skipped from review due to trivial changes (2)
  • .changelog/v5.1.1/api-breaking/provider/2095-proto-message-fix.md
  • .changelog/v5.1.1/state-breaking/provider/2095-proto-message-fix.md
Additional context used
LanguageTool
docs/docs/integrators/integrating_inactive_validators.md

[style] ~7-~7: This phrase is redundant. Consider using “outside”.
Context: ...ing-inactive-validators.md), validators outside of the active set on the provider chain ca...

(OUTSIDE_OF)


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.

@github-actions github-actions bot added the C:Docs Assigned automatically by the PR labeler label Aug 13, 2024
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

Outside diff range, codebase verification and nitpick comments (1)
docs/docs/integrators/integrating_inactive_validators.md (1)

7-7: Consider revising for conciseness.

The phrase "outside of the active set" is slightly redundant. Consider using "outside the active set" for conciseness.

- validators outside of the active set on the provider chain can validate on consumer chains
+ validators outside the active set on the provider chain can validate on consumer chains
Tools
LanguageTool

[style] ~7-~7: This phrase is redundant. Consider using “outside”.
Context: ...ing-inactive-validators.md), validators outside of the active set on the provider chain ca...

(OUTSIDE_OF)

@mpoke mpoke enabled auto-merge August 14, 2024 10:12
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

Outside diff range, codebase verification and nitpick comments (1)
docs/docs/integrators/integrating_inactive_validators.md (1)

7-7: Consider simplifying the phrase.

The phrase "outside of the active set" can be simplified to "outside the active set" for improved readability.

- validators outside of the active set on the provider chain
+ validators outside the active set on the provider chain
Tools
LanguageTool

[style] ~7-~7: This phrase is redundant. Consider using “outside”.
Context: ...ing-inactive-validators.md), validators outside of the active set on the provider chain ca...

(OUTSIDE_OF)

@mpoke mpoke closed this Aug 14, 2024
auto-merge was automatically disabled August 14, 2024 12:16

Pull request was closed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C:Docs Assigned automatically by the PR labeler
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants