docs: fix typos in documentation files #23063
Conversation
📝 WalkthroughWalkthroughThe pull request involves minor documentation updates to the Changes
Possibly related PRs
Suggested reviewers
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
Documentation and Community
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
docs/user/run-node/04-rosetta.md (2)
79-79: Improve grammar and hyphenation in the plugin setup description.The sentence structure needs improvement, and compound modifiers should be hyphenated.
-To use Rosetta over any chain, it is required to set up prefixes and registering zone specific interfaces through plugins. +To use Rosetta over any chain, you need to set up prefixes and register zone-specific interfaces through plugins.🧰 Tools
🪛 LanguageTool
[uncategorized] ~79-~79: This verb may not be in the correct form. Consider using a different form for this context.
Context: ..., it is required to set up prefixes and registering zone specific interfaces through plugin...(AI_EN_LECTOR_REPLACEMENT_VERB_FORM)
[uncategorized] ~79-~79: When ‘zone-specific’ is used as a modifier, it is usually spelled with a hyphen.
Context: ...ired to set up prefixes and registering zone specific interfaces through plugins. Each plugi...(SPECIFIC_HYPHEN)
81-83: Improve formatting and punctuation in the implementation details.Several formatting and punctuation improvements are needed:
- Hyphenate compound modifiers
- Add Oxford comma
- Use consistent list markers (asterisks instead of dashes)
-Each plugin is a minimalist implementation of `InitZone` and `RegisterInterfaces` which allow Rosetta to parse chain specific data. There is an example for cosmos-hub chain under `plugins/cosmos-hub/` folder -- **InitZone**: An empty method that is executed first and defines prefixes, parameters and other settings. -- **RegisterInterfaces**: This method receives an interface registry which is where the zone specific types and interfaces will be loaded +Each plugin is a minimalist implementation of `InitZone` and `RegisterInterfaces` which allow Rosetta to parse chain-specific data. There is an example for cosmos-hub chain under `plugins/cosmos-hub/` folder +* **InitZone**: An empty method that is executed first and defines prefixes, parameters, and other settings. +* **RegisterInterfaces**: This method receives an interface registry, which is where the zone-specific types and interfaces will be loaded🧰 Tools
🪛 LanguageTool
[uncategorized] ~81-~81: When ‘chain-specific’ is used as a modifier, it is usually spelled with a hyphen.
Context: ...nterfaces` which allow Rosetta to parse chain specific data. There is an example for cosmos-hu...(SPECIFIC_HYPHEN)
[uncategorized] ~83-~83: Possible missing comma found.
Context: ...es**: This method receives an interface registry which is where the zone specific types ...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~83-~83: When ‘zone-specific’ is used as a modifier, it is usually spelled with a hyphen.
Context: ...n interface registry which is where the zone specific types and interfaces will be loaded In...(SPECIFIC_HYPHEN)
🪛 Markdownlint (0.37.0)
82-82: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
83-83: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
82-82: null
Lists should be surrounded by blank lines(MD032, blanks-around-lists)
📜 Review details
Configuration used: .coderabbit.yml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/user/run-node/04-rosetta.md(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
docs/user/run-node/04-rosetta.md (1)
Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"
🪛 LanguageTool
docs/user/run-node/04-rosetta.md
[uncategorized] ~79-~79: This verb may not be in the correct form. Consider using a different form for this context.
Context: ..., it is required to set up prefixes and registering zone specific interfaces through plugin...
(AI_EN_LECTOR_REPLACEMENT_VERB_FORM)
[uncategorized] ~79-~79: When ‘zone-specific’ is used as a modifier, it is usually spelled with a hyphen.
Context: ...ired to set up prefixes and registering zone specific interfaces through plugins. Each plugi...
(SPECIFIC_HYPHEN)
[uncategorized] ~81-~81: When ‘chain-specific’ is used as a modifier, it is usually spelled with a hyphen.
Context: ...nterfaces` which allow Rosetta to parse chain specific data. There is an example for cosmos-hu...
(SPECIFIC_HYPHEN)
[uncategorized] ~83-~83: Possible missing comma found.
Context: ...es**: This method receives an interface registry which is where the zone specific types ...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~83-~83: When ‘zone-specific’ is used as a modifier, it is usually spelled with a hyphen.
Context: ...n interface registry which is where the zone specific types and interfaces will be loaded In...
(SPECIFIC_HYPHEN)
🪛 Markdownlint (0.37.0)
docs/user/run-node/04-rosetta.md
82-82: Expected: asterisk; Actual: dash
Unordered list style
(MD004, ul-style)
83-83: Expected: asterisk; Actual: dash
Unordered list style
(MD004, ul-style)
82-82: null
Lists should be surrounded by blank lines
(MD032, blanks-around-lists)
🔇 Additional comments (1)
docs/user/run-node/04-rosetta.md (1)
81-81: LGTM: Plugin path is correctly updated.
The plugin path is now correctly specified as plugins/cosmos-hub/.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~81-~81: When ‘chain-specific’ is used as a modifier, it is usually spelled with a hyphen.
Context: ...nterfaces` which allow Rosetta to parse chain specific data. There is an example for cosmos-hu...
(SPECIFIC_HYPHEN)
julienrbrt
changed the title
tac0turtle
added
the
backport/v0.52.x
Pull Request is not mergeable
Pull Request is not mergeable
(cherry picked from commit d1f9fd8)
Corrected
weretowherex2Corrected
huntohubSummary by CodeRabbit
04-rosetta.mddocument for improved clarity and corrected typographical errors.plugins/cosmos-hun/toplugins/cosmos-hub/.