docs: fix misspelled issues #25080
docs: fix misspelled issues #25080
Conversation
📝 WalkthroughWalkthroughA series of minor grammatical and typographical corrections were made across multiple ADR documentation files. These changes address spelling errors, grammar mistakes, and clarity issues, but do not alter any functional, logical, or technical content in the documents. 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: 0
🧹 Nitpick comments (5)
docs/architecture/adr-058-auto-generated-cli.md (1)
83-85: Clarify pluralization in the fixed sentenceNice catch on “lie” vs “line.”
While you are touching this sentence, consider removing the extra “s” so it reads “customization options” (singular noun, plural object).-as to whether these customizations options should lie in: +as to whether these customization options should lie in:docs/architecture/adr-060-abci-1.0.md (1)
85-88: Replace hard tab with spaces for markdown-lint compliance
markdownlintflags hard tabs (MD010). Swapping the single tab for two spaces avoids the warning without affecting the Go snippet’s readability.- // be closed by the caller. + // be closed by the caller.docs/architecture/adr-063-core-module-api.md (2)
283-286: Use singular form for interface name
HasPreBlockeris a single interface, not multiple.-Modules that have functionality that runs before BeginBlock and should implement the `HasPreBlocker` interfaces: +Modules that have functionality that runs before BeginBlock should implement the `HasPreBlocker` interface:
296-299: Remove stray word “has”Minor grammar touch-up keeps the doc professional and unambiguous.
-(end blockers) should implement the has `HasBeginBlocker` and/or `HasEndBlocker` interfaces: +(end blockers) should implement the `HasBeginBlocker` and/or `HasEndBlocker` interfaces:docs/architecture/adr-050-sign-mode-textual.md (1)
228-231: Tweak pluralisation helper commentThe example is still a bit clumsy and duplicates spaces. A small edit improves readability.
-This transaction has <int> message: // Optional 's' for "message" if there's >1 sdk.Msgs. +This transaction has <int> message(s): // Optional 's' for "message' if there are >1 sdk.Msgs.
📜 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 (10)
docs/architecture/adr-046-module-params.md(1 hunks)docs/architecture/adr-047-extend-upgrade-plan.md(2 hunks)docs/architecture/adr-050-sign-mode-textual.md(1 hunks)docs/architecture/adr-054-semver-compatible-modules.md(1 hunks)docs/architecture/adr-058-auto-generated-cli.md(1 hunks)docs/architecture/adr-059-test-scopes.md(1 hunks)docs/architecture/adr-060-abci-1.0.md(1 hunks)docs/architecture/adr-063-core-module-api.md(1 hunks)docs/architecture/adr-065-store-v2.md(2 hunks)docs/architecture/adr-076-tx-malleability.md(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
docs/architecture/adr-060-abci-1.0.md
87-87: 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 (6)
docs/architecture/adr-059-test-scopes.md (1)
154-157: Typo fixed – looks goodThe removal of the duplicate article makes the sentence flow correctly.
No further issues spotted.docs/architecture/adr-076-tx-malleability.md (1)
129-133: Corrected spelling – good to merge“Malleability” is now spelled correctly; content remains unchanged.
docs/architecture/adr-046-module-params.md (1)
163-166: Grammar fix acceptedChanging “becomes” → “become” aligns subject–verb agreement.
No other concerns.docs/architecture/adr-054-semver-compatible-modules.md (1)
474-476: Typo fix approvedThe sentence now reads correctly (“could call this”).
docs/architecture/adr-065-store-v2.md (1)
38-39: Clarity improvement looks goodReplacing “through” and fixing “shortcomings” reads better; no further action required.
docs/architecture/adr-047-extend-upgrade-plan.md (1)
60-63: Correct branding spelling approvedChanging “Cosmosvisor” ➜ “Cosmovisor” keeps naming consistent.
2 participants
Description
becomes-becomeCosmosvisor-Cosmovisoris >1 sdk.Msgs.- deleted redundantcould all this-could call thisenvironment and the this- deleted redundantbe closed by the caller.- add bethe has HasPreBlocker- deleted redundantthough-throughshort comings-shortcomingsmalleablity-malleabilitySummary by CodeRabbit