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 typo #6455

Merged
merged 1 commit into from
Jun 3, 2024
Merged

docs: fix typo #6455

merged 1 commit into from
Jun 3, 2024

Conversation

healthyyyoung
Copy link
Contributor

@healthyyyoung healthyyyoung commented Jun 3, 2024

Description

closes: #XXXX


Before we can merge this PR, please make sure that all the following items have been
checked off. If any of the checklist items are not applicable, please leave them but
write a little note why.

  • Targeted PR against the correct branch (see CONTRIBUTING.md).
  • Linked to GitHub issue with discussion and accepted design, OR link to spec that describes this work.
  • Code follows the module structure standards and Go style guide.
  • Wrote unit and integration tests.
  • Updated relevant documentation (docs/).
  • Added relevant godoc comments.
  • Provide a conventional commit message to follow the repository standards.
  • Include a descriptive changelog entry when appropriate. This may be left to the discretion of the PR reviewers. (e.g. chores should be omitted from changelog)
  • Re-reviewed Files changed in the GitHub PR explorer.
  • Review SonarCloud Report in the comment section below once CI passes.

Summary by CodeRabbit

  • Documentation
    • Corrected a typo in multiple versions of the IBC integration documentation, changing "ibc-tranfer" to "ibc-transfer" for clarity and accuracy.

Copy link
Contributor

coderabbitai bot commented Jun 3, 2024

Walkthrough

Walkthrough

The changes across various versions of the integration.md file primarily involve correcting a typo in comments related to setting up an IBC router. The word "ibc-tranfer" was corrected to "ibc-transfer" for clarity and accuracy. No significant modifications were made to the declarations of exported or public entities, except in version v5.4.x, where a comment was updated.

Changes

File Path Change Summary
docs/versioned_docs/version-v4.6.x/.../integration.md Corrected a typo in a comment: changed "ibc-tranfer" to "ibc-transfer."
docs/versioned_docs/version-v5.4.x/.../integration.md Corrected a typo in a comment and updated a comment in the declaration of func NewApp(...args) *App.
docs/versioned_docs/version-v6.3.x/.../integration.md Corrected a typo in a comment: changed "ibc-tranfer" to "ibc-transfer."
docs/versioned_docs/version-v7.5.x/.../integration.md Corrected a typo in a comment: changed "ibc-tranfer" to "ibc-transfer."

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

@crodriguezvega crodriguezvega left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, @healthyyyoung!

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.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 33de45f and f531e76.

Files selected for processing (4)
  • docs/versioned_docs/version-v4.6.x/01-ibc/02-integration.md (1 hunks)
  • docs/versioned_docs/version-v5.4.x/01-ibc/02-integration.md (1 hunks)
  • docs/versioned_docs/version-v6.3.x/01-ibc/02-integration.md (1 hunks)
  • docs/versioned_docs/version-v7.5.x/01-ibc/02-integration.md (1 hunks)
Additional context used
Path-based instructions (4)
docs/versioned_docs/version-v4.6.x/01-ibc/02-integration.md (1)

Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"

docs/versioned_docs/version-v5.4.x/01-ibc/02-integration.md (1)

Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"

docs/versioned_docs/version-v6.3.x/01-ibc/02-integration.md (1)

Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"

docs/versioned_docs/version-v7.5.x/01-ibc/02-integration.md (1)

Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"

LanguageTool
docs/versioned_docs/version-v4.6.x/01-ibc/02-integration.md

[uncategorized] ~25-~25: When ‘Set-up’ is used as a noun or modifier, it needs to be hyphenated.
Context: ...eKeysand initialize theirKeepers` - Set up corresponding routers and routes for th...


[style] ~81-~81: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...ibc, and x/ibc-transfer` modules), we need to grant specific capabilities through the...


[style] ~117-~117: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...nues } ``` ### Register Routers IBC needs to know which module is bound to which por...


[uncategorized] ~127-~127: Possible missing comma found.
Context: ... or a packet. Currently, a Router is static so it must be initialized and set corre...


[style] ~146-~146: Consider a shorter alternative to avoid wordiness.
Context: ... .. continues ``` ### Module Managers In order to use IBC, we need to add the new modules...


[uncategorized] ~178-~178: Possible missing comma found.
Context: ...the Header and ValidatorSet of this chain which is stored at each height during t...


[style] ~180-~180: Consider a shorter alternative to avoid wordiness.
Context: ...ast historical info at any given height in order to verify the light client `ConsensusState...


[uncategorized] ~184-~184: Possible missing comma found.
Context: ...-client/abci.go) logic as well. This is optional as it is only required if your applicat...


[style] ~220-~220: As a shorter alternative for ‘able to’, consider using “can now”.
Context: ...ou have now wired up the IBC module and are now able to send fungible tokens across different c...


[uncategorized] ~221-~221: Possible missing comma found.
Context: ... you want to have a broader view of the changes take a look into the SDK's [SimApp](h...

docs/versioned_docs/version-v5.4.x/01-ibc/02-integration.md

[uncategorized] ~25-~25: When ‘Set-up’ is used as a noun or modifier, it needs to be hyphenated.
Context: ...eKeysand initialize theirKeepers` - Set up corresponding routers and routes for th...


[style] ~81-~81: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...ibc, and x/ibc-transfer` modules), we need to grant specific capabilities through the...


[style] ~117-~117: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...nues } ``` ### Register Routers IBC needs to know which module is bound to which por...


[style] ~146-~146: Consider a shorter alternative to avoid wordiness.
Context: ... .. continues ``` ### Module Managers In order to use IBC, we need to add the new modules...


[uncategorized] ~178-~178: Possible missing comma found.
Context: ...the Header and ValidatorSet of this chain which is stored at each height during t...


[style] ~180-~180: Consider a shorter alternative to avoid wordiness.
Context: ...ast historical info at any given height in order to verify the light client `ConsensusState...


[style] ~220-~220: As a shorter alternative for ‘able to’, consider using “can now”.
Context: ...ou have now wired up the IBC module and are now able to send fungible tokens across different c...


[uncategorized] ~221-~221: A comma might be missing here.
Context: ... you want to have a broader view of the changes take a look into the SDK's [SimApp](h...

docs/versioned_docs/version-v6.3.x/01-ibc/02-integration.md

[uncategorized] ~25-~25: When ‘Set-up’ is used as a noun or modifier, it needs to be hyphenated.
Context: ...eKeysand initialize theirKeepers` - Set up corresponding routers and routes for th...


[style] ~81-~81: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...ibc, and x/ibc-transfer` modules), we need to grant specific capabilities through the...


[style] ~117-~117: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...nues } ``` ### Register Routers IBC needs to know which module is bound to which por...


[uncategorized] ~127-~127: Possible missing comma found.
Context: ... or a packet. Currently, a Router is static so it must be initialized and set corre...


[style] ~146-~146: Consider a shorter alternative to avoid wordiness.
Context: ... .. continues ``` ### Module Managers In order to use IBC, we need to add the new modules...


[style] ~180-~180: Consider a shorter alternative to avoid wordiness.
Context: ...ast historical info at any given height in order to verify the light client `ConsensusState...


[uncategorized] ~184-~184: Possible missing comma found.
Context: ...-client/abci.go) logic as well. This is optional as it is only required if your applicat...


[style] ~220-~220: As a shorter alternative for ‘able to’, consider using “can now”.
Context: ...ou have now wired up the IBC module and are now able to send fungible tokens across different c...


[uncategorized] ~221-~221: Possible missing comma found.
Context: ... you want to have a broader view of the changes take a look into the SDK's [SimApp](h...

docs/versioned_docs/version-v7.5.x/01-ibc/02-integration.md

[style] ~40-~40: ‘is in contrast to’ might be wordy. Consider a shorter alternative.
Context: ... follow the steps listed below. This is in contrast to earlier versions of ibc-go when `07-ten...


[style] ~138-~138: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...nues } ``` ### Register Routers IBC needs to know which module is bound to which por...


[uncategorized] ~148-~148: Possible missing comma found.
Context: ... or a packet. Currently, a Router is static so it must be initialized and set corre...


[style] ~167-~167: Consider a shorter alternative to avoid wordiness.
Context: ... .. continues ``` ### Module Managers In order to use IBC, we need to add the new modules...


[uncategorized] ~199-~199: Possible missing comma found.
Context: ...the Header and ValidatorSet of this chain which is stored at each height during t...


[style] ~201-~201: Consider a shorter alternative to avoid wordiness.
Context: ...ast historical info at any given height in order to verify the light client `ConsensusState...


[style] ~233-~233: As a shorter alternative for ‘able to’, consider using “can now”.
Context: ...ou have now wired up the IBC module and are now able to send fungible tokens across different c...


[uncategorized] ~234-~234: A comma might be missing here.
Context: ... you want to have a broader view of the changes take a look into the SDK's [SimApp](h...

Markdownlint
docs/versioned_docs/version-v4.6.x/01-ibc/02-integration.md

8-8: null
Multiple top-level headings in the same document

docs/versioned_docs/version-v5.4.x/01-ibc/02-integration.md

8-8: null
Multiple top-level headings in the same document

docs/versioned_docs/version-v6.3.x/01-ibc/02-integration.md

8-8: null
Multiple top-level headings in the same document

docs/versioned_docs/version-v7.5.x/01-ibc/02-integration.md

12-12: Expected: 0 or 2; Actual: 1
Trailing spaces


39-39: Expected: 0 or 2; Actual: 1
Trailing spaces


9-9: null
Multiple top-level headings in the same document

Additional comments not posted (4)
docs/versioned_docs/version-v4.6.x/01-ibc/02-integration.md (1)

135-135: Corrected typo in the comment.

docs/versioned_docs/version-v5.4.x/01-ibc/02-integration.md (1)

135-135: Corrected typo in the comment.

docs/versioned_docs/version-v6.3.x/01-ibc/02-integration.md (1)

135-135: Corrected typo in the comment.

docs/versioned_docs/version-v7.5.x/01-ibc/02-integration.md (1)

156-156: Corrected typo in the comment.

@colin-axner colin-axner enabled auto-merge (squash) June 3, 2024 15:05
@colin-axner colin-axner merged commit 027e515 into cosmos:main Jun 3, 2024
26 checks passed
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