chore: spelling and grammar #25067
chore: spelling and grammar #25067
Conversation
📝 WalkthroughWalkthroughA series of architecture decision record (ADR) documentation files were updated to correct grammar, improve clarity, and standardize terminology. All changes are editorial, with no modifications to technical content, logic, or code. No changes were made to exported or public entities. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes ✨ 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: 3
🧹 Nitpick comments (3)
docs/architecture/adr-034-account-rekeying.md (2)
17-17: Use “cannot” instead of “can not”Conventional style and LanguageTool recommendation.
- it can not be updated. + it cannot be updated.
46-46: Colloquial wording & hard tab
- Replace informal “anyways” → “anyway”.
- Remove the hard tab character reported by markdown-lint.
- do not automatically prune any accounts anyways, but we would like + do not automatically prune any accounts anyway, but we would likedocs/architecture/adr-033-protobuf-inter-module-comm.md (1)
31-32: Grammar glitch in bullet 2The phrase has an extra verb.
- ...which makes refactors of module keeper interfaces is inevitable... + ...which makes refactors of module-keeper interfaces inevitable...
📜 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 (6)
docs/architecture/adr-031-msg-service.md(2 hunks)docs/architecture/adr-032-typed-events.md(2 hunks)docs/architecture/adr-033-protobuf-inter-module-comm.md(4 hunks)docs/architecture/adr-034-account-rekeying.md(4 hunks)docs/architecture/adr-035-rosetta-api-support.md(3 hunks)docs/architecture/adr-036-arbitrary-signature.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/architecture/adr-033-protobuf-inter-module-comm.md
[style] ~29-~29: ‘off of’ might be wordy. Consider a shorter alternative.
Context: ...stable v1.0 Cosmos SDK to build modules off of. Module interfaces are changing, someti...
(EN_WORDINESS_PREMIUM_OFF_OF)
docs/architecture/adr-034-account-rekeying.md
[style] ~17-~17: Unless you want to emphasize “not”, use “cannot” which is more common.
Context: ...ce a multisig for an account is set, it can not be updated. This is problematic, as mu...
(CAN_NOT_PREMIUM)
[style] ~46-~46: The word ‘anyways’ is informal American English. Did you mean “anyway”?
Context: ...do not automatically prune any accounts anyways, but we would like to keep this option ...
(ANYWAYS)
🪛 markdownlint-cli2 (0.17.2)
docs/architecture/adr-034-account-rekeying.md
46-46: Hard tabs
Column: 1
(MD010, no-hard-tabs)
⏰ 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 (9)
docs/architecture/adr-036-arbitrary-signature.md (1)
20-28: Editorial tweaks look goodAll wording adjustments improve clarity without altering technical meaning. No further changes required.
docs/architecture/adr-032-typed-events.md (2)
156-157: Clarity improvement acknowledgedThe re-phrased sentence reads better and is grammatically correct.
263-264: Good grammar fixSwitching “Waits on” to “Waits for” corrects the preposition.
docs/architecture/adr-033-protobuf-inter-module-comm.md (1)
36-37: Hyphenation acknowledged“pretty much-unrestricted” is acceptable; no action needed.
docs/architecture/adr-035-rosetta-api-support.md (5)
17-17: Consistency in spelling looks goodSwitching to the American-English “standardize” aligns with the style used throughout the SDK docs. No further action needed.
29-29: Correct compound-adjective hyphenationAdding the hyphen in “Cosmos SDK-based chains” improves readability and follows standard style guidelines.
33-33: Removal of unnecessary hyphen is appropriateChanging “set-up” (noun) to the verb phrase “set up” is grammatically correct in this context.
36-36: Hyphenation of “Long-term support” is correctThe added hyphen clarifies that “long-term” modifies “support.”
208-208: Spelling aligned with earlier change“Standardization” matches the American-English spelling chosen above; keeps terminology consistent.
| Finally, closing a module to the client API opens desirable OCAP patterns discussed in ADR-033. Since server implementation and interface is hidden, nobody can hold "keepers"/servers and will be forced to relay on the client interface, which will drive developers for correct encapsulation and software engineering patterns. | ||
|
|
There was a problem hiding this comment.
Typo: “relay on” → “rely on”
- will be forced to relay on the client interface,
+ will be forced to rely on the client interface,📝 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.
| Finally, closing a module to the client API opens desirable OCAP patterns discussed in ADR-033. Since server implementation and interface is hidden, nobody can hold "keepers"/servers and will be forced to relay on the client interface, which will drive developers for correct encapsulation and software engineering patterns. | |
| Finally, closing a module to the client API opens desirable OCAP patterns discussed in ADR-033. Since server implementation and interface is hidden, nobody can hold "keepers"/servers and will be forced to rely on the client interface, which will drive developers for correct encapsulation and software engineering patterns. |
🤖 Prompt for AI Agents
In docs/architecture/adr-031-msg-service.md around lines 182 to 183, correct the
typo by replacing "relay on" with "rely on" to fix the incorrect phrase usage.
| @@ -1,4 +1,4 @@ | |||
| # ADR 034: Account Rekeying | |||
| <# ADR 034: Account Rekeying | |||
There was a problem hiding this comment.
Header is malformed Markdown
<# ADR 034: … renders literally instead of a heading.
-<# ADR 034: Account Rekeying
+# ADR 034: Account Rekeying📝 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.
| <# ADR 034: Account Rekeying | |
| # ADR 034: Account Rekeying |
🤖 Prompt for AI Agents
In docs/architecture/adr-034-account-rekeying.md at line 1, the header is
incorrectly formatted as `<# ADR 034: Account Rekeying` which renders literally
instead of as a Markdown heading. Replace the `<#` with a proper Markdown
heading syntax, such as `#` followed by a space, to correctly format it as a
level 1 heading.
| ### Neutral | ||
|
|
||
| * While the purpose of this is intended to allow the owner of an account to update to a new pubkey they own, this could technically also be used to transfer ownership of an account to a new owner. For example, this could be use used to sell a staked position without unbonding or an account that has vesting tokens. However, the friction of this is very high as this would essentially have to be done as a very specific OTC trade. Furthermore, additional constraints could be added to prevent accounts with Vesting tokens to use this feature. | ||
| * While the purpose of this is intended to allow the owner of an account to update to a new pubkey they own, this could technically also be used to transfer ownership of an account to a new owner. For example, this could be use used to sell a staked position without unbonding or an account that has vesting tokens. However, the friction of this is very high as this would essentially have to be done as a very specific OTC trade. Furthermore, additional constraints could be added to prevent accounts with Vesting tokens from using this feature. |
There was a problem hiding this comment.
Duplicate word “use used”
- this could be use used to sell a staked position
+ this could be used to sell a staked position📝 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.
| * While the purpose of this is intended to allow the owner of an account to update to a new pubkey they own, this could technically also be used to transfer ownership of an account to a new owner. For example, this could be use used to sell a staked position without unbonding or an account that has vesting tokens. However, the friction of this is very high as this would essentially have to be done as a very specific OTC trade. Furthermore, additional constraints could be added to prevent accounts with Vesting tokens from using this feature. | |
| * While the purpose of this is intended to allow the owner of an account to update to a new pubkey they own, this could technically also be used to transfer ownership of an account to a new owner. For example, this could be used to sell a staked position without unbonding or an account that has vesting tokens. However, the friction of this is very high as this would essentially have to be done as a very specific OTC trade. Furthermore, additional constraints could be added to prevent accounts with Vesting tokens from using this feature. |
🤖 Prompt for AI Agents
In docs/architecture/adr-034-account-rekeying.md at line 71, there is a
duplicate word "use used" in the sentence. Remove the extra "use" so the phrase
reads correctly as "this could be used to sell a staked position without
unbonding or an account that has vesting tokens."
2 participants
Description
Closes: #XXXX
Summary by CodeRabbit