docs: fix typos and grammatical errors #25074
Conversation
github-actions
bot
added
C:x/gov
C:x/auth
C:x/upgrade
C:x/feegrant
C:x/authz
Type: ADR
labels
📝 WalkthroughWalkthroughThis change set consists exclusively of minor typographical corrections across several code comments and documentation files. No code logic, control flow, or error handling is affected. All updates are limited to improving textual accuracy and clarity in comments, error messages, and documentation. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Note ⚡️ Unit Test Generation is now available in beta!Learn more here, or try it out under "Finishing Touches" below. ✨ Finishing Touches
🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. 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
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (2)
docs/architecture/adr-049-state-sync-hooks.md (1)
142-142: Polish the wording for clarityMinor style nits that slipped through the typo-sweep:
-As a result of this implementation, we are able to create snapshots of binary chunk stream for the state that we maintain outside of the IAVL Tree, CosmWasm blobs for example. And new clients are able to fetch snapshots of state for all modules that have implemented the corresponding interface from peer nodes. +As a result of this implementation, we can create binary-chunk snapshots for state we maintain outside the IAVL tree—CosmWasm blobs, for example. New clients can fetch the snapshots for all modules that implement the interface from peer nodes.x/gov/types/v1/params.go (1)
189-191: Spelling nit: change “less that” → “less than” in error stringTiny grammar slip remains nearby—worth fixing while you’re here.
- return fmt.Errorf("expedited voting period %s must be strictly less that the regular voting period %s", p.ExpeditedVotingPeriod, p.VotingPeriod) + return fmt.Errorf("expedited voting period %s must be strictly less than the regular voting period %s", p.ExpeditedVotingPeriod, p.VotingPeriod)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Knowledge Base: Disabled due to Reviews > Disable Knowledge Base setting
📒 Files selected for processing (7)
baseapp/abci.go(1 hunks)docs/architecture/adr-049-state-sync-hooks.md(1 hunks)x/auth/vesting/README.md(1 hunks)x/authz/README.md(1 hunks)x/feegrant/migrations/v2/keys.go(1 hunks)x/gov/types/v1/params.go(1 hunks)x/upgrade/README.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/architecture/adr-049-state-sync-hooks.md
[style] ~142-~142: As a shorter alternative for ‘able to’, consider using “can”.
Context: ... As a result of this implementation, we are able to create snapshots of binary chunk stream...
(BE_ABLE_TO)
[style] ~142-~142: This phrase is redundant. Consider using “outside”.
Context: ...k stream for the state that we maintain outside of the IAVL Tree, CosmWasm blobs for examp...
(OUTSIDE_OF)
[style] ~142-~142: As a shorter alternative for ‘able to’, consider using “can”.
Context: ...Wasm blobs for example. And new clients are able to fetch snapshots of state for all module...
(BE_ABLE_TO)
x/auth/vesting/README.md
[grammar] ~44-~44: Ensure spelling is correct
Context: ... ContinuousVesting, PeriodicVesting and PermanantVesting accounts can be created with normal mes...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Summary
🔇 Additional comments (5)
baseapp/abci.go (1)
927-927: Typo fix looks goodThe updated comment now reads correctly; no further action needed.
x/feegrant/migrations/v2/keys.go (1)
27-27: Comment typo resolvedComment now conveys the intent unambiguously. ✅
x/upgrade/README.md (1)
94-94: Spacing correction acceptedThe phrase now reads naturally. No further changes required.
x/gov/types/v1/params.go (1)
195-202: Typo fixes in error messages — LGTM“minimum” is now spelled correctly in all three affected error strings, keeping messaging consistent and professional.
x/authz/README.md (1)
99-100: Minor doc typo corrected — LGTMThe “in case” spacing fix reads better; no further issues spotted.
| ## Note | ||
|
|
||
| Vesting accounts can be initialized with some vesting and non-vesting coins. The non-vesting coins would be immediately transferable. DelayedVesting ContinuousVesting, PeriodicVesting and PermenantVesting accounts can be created with normal messages after genesis. Other types of vesting accounts must be created at genesis, or as part of a manual network upgrade. The current specification only allows for _unconditional_ vesting (ie. there is no possibility of reaching `ET` and | ||
| Vesting accounts can be initialized with some vesting and non-vesting coins. The non-vesting coins would be immediately transferable. DelayedVesting ContinuousVesting, PeriodicVesting and PermanantVesting accounts can be created with normal messages after genesis. Other types of vesting accounts must be created at genesis, or as part of a manual network upgrade. The current specification only allows for _unconditional_ vesting (ie. there is no possibility of reaching `ET` and |
There was a problem hiding this comment.
Remaining misspelling: “PermanantVesting” → “PermanentVesting”
The new text still contains a misspelling.
-DelayedVesting ContinuousVesting, PeriodicVesting and PermanantVesting accounts can be created with normal messages after genesis.
+DelayedVesting, ContinuousVesting, PeriodicVesting and PermanentVesting accounts can be created with normal messages after genesis.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| Vesting accounts can be initialized with some vesting and non-vesting coins. The non-vesting coins would be immediately transferable. DelayedVesting ContinuousVesting, PeriodicVesting and PermanantVesting accounts can be created with normal messages after genesis. Other types of vesting accounts must be created at genesis, or as part of a manual network upgrade. The current specification only allows for _unconditional_ vesting (ie. there is no possibility of reaching `ET` and | |
| Vesting accounts can be initialized with some vesting and non-vesting coins. The non-vesting coins would be immediately transferable. DelayedVesting, ContinuousVesting, PeriodicVesting and PermanentVesting accounts can be created with normal messages after genesis. Other types of vesting accounts must be created at genesis, or as part of a manual network upgrade. The current specification only allows for _unconditional_ vesting (ie. there is no possibility of reaching `ET` and |
🧰 Tools
🪛 LanguageTool
[grammar] ~44-~44: Ensure spelling is correct
Context: ... ContinuousVesting, PeriodicVesting and PermanantVesting accounts can be created with normal mes...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
🤖 Prompt for AI Agents
In x/auth/vesting/README.md at line 44, correct the misspelling of
"PermanantVesting" to "PermanentVesting" to ensure accurate terminology in the
documentation.
2 participants
Description
This PR fixes various typographical and grammatical errors found across the codebase.
Documentation Fixes
x/auth/vesting/README.md: Fixed typo "PermenantVesting" → "PermanentVesting"x/authz/README.md: Corrected "incase" → "in case"x/upgrade/README.md: Fixed "everytime" → "every time"Code Comment Fixes
baseapp/abci.go: Fixed typo "checkes" → "checks" in function commentx/feegrant/migrations/v2/keys.go: Corrected "everytime" → "every time" in commentError Message Fixes
x/gov/types/v1/params.go: Fixed "mininum" → "minimum" in three error messagesSummary by CodeRabbit