docs: fix grammatical and terminology issues in ADR documents #25066
Conversation
📝 WalkthroughWalkthroughThis update consists exclusively of minor textual and grammatical corrections across multiple documentation files. The changes include typo fixes, improved wording, formatting adjustments, and clarification of existing sentences. No code, logic, functionality, or exported/public entity declarations are affected. 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 (7)
docs/docs/learn/beginner/01-tx-lifecycle.md (1)
99-103: Minor phrasing nit – consider tightening
While the extra-space removal after “CometBFT)” is correct, you can drop the wordy “in order to” for a crisper sentence:-...needs to be unmarshaled in order to be processed. +...needs to be unmarshaled to be processed.docs/architecture/adr-045-check-delivertx-middlewares.md (1)
67-67: Prefer “different from” over “different than”.Minor style nit: technical writing typically uses “different from”. Consider the edit below.
-Please note that because CheckTx handles separate logic related to mempool prioritization, its signature is different than DeliverTx and SimulateTx. +Please note that because CheckTx handles separate logic related to mempool prioritization, its signature is different from DeliverTx and SimulateTx.docs/rfc/PROCESS.md (1)
13-13: Sentence still a bit convoluted—consider re-phrasing.Current wording is lengthy and hard to parse. A crisper alternative:
-The main difference the Cosmos SDK is defining as a differentiation between RFC and ADRs is that one is to come to consensus and circulate information about a potential change or feature. +The Cosmos SDK differentiates RFCs and ADRs as follows: an RFC is used to build consensus and circulate information about a potential change or feature,Optional, but improves clarity.
docs/architecture/adr-036-arbitrary-signature.md (2)
20-20: “On Ethereum” reads more naturally.In blockchain parlance we usually say “on Ethereum” (the network), not “in Ethereum”. Suggest reverting:
-Currently, in the Cosmos SDK, there is no convention to sign arbitrary message like in Ethereum. +Currently, in the Cosmos SDK, there is no convention to sign arbitrary messages like on Ethereum.Also pluralise “message” → “messages”.
54-54: Minor wording polish.“Validatable off-chain only” feels awkward; “only validatable off-chain” flows better.
-`MsgSignData` allows developers to sign arbitrary bytes validatable offchain only. +`MsgSignData` allows developers to sign arbitrary bytes that are only validatable off-chain.docs/docs/user/run-node/03-txs.md (1)
421-424: Prefer standard quoting & remove leading whitespace inside JSON payloadLeading whitespace is harmless but unconventional and slightly clutters the example. Using the canonical
-d '{...}'form keeps the snippet consistent with the rest of the docs.- -d' {"tx_bytes":"{{txBytes}}","mode":"BROADCAST_MODE_SYNC"}' \ + -d '{ "tx_bytes":"{{txBytes}}","mode":"BROADCAST_MODE_SYNC"}' \docs/architecture/adr-050-sign-mode-textual-annex1.md (1)
54-56: Grammar tweak: “is displayed” & tighten phrasing-* an array of `coin` is display as the concatenation of each `coin` encoded as the specification above, then joined together with the delimiter `", "` (a comma and a space, no quotes around). +* an array of `coin` is displayed as the concatenation of each encoded `coin`, joined with the delimiter `", "` (comma + space, no quotes).
📜 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 (14)
docs/architecture/adr-036-arbitrary-signature.md(2 hunks)docs/architecture/adr-045-check-delivertx-middlewares.md(1 hunks)docs/architecture/adr-047-extend-upgrade-plan.md(1 hunks)docs/architecture/adr-050-sign-mode-textual-annex1.md(1 hunks)docs/architecture/adr-053-go-module-refactoring.md(1 hunks)docs/docs/learn/beginner/01-tx-lifecycle.md(1 hunks)docs/docs/learn/intro/01-why-app-specific.md(1 hunks)docs/docs/learn/intro/02-sdk-app-architecture.md(1 hunks)docs/docs/learn/learn.md(1 hunks)docs/docs/user/run-node/01-run-node.md(1 hunks)docs/docs/user/run-node/03-txs.md(1 hunks)docs/rfc/PROCESS.md(1 hunks)docs/spec/README.md(1 hunks)docs/spec/addresses/bech32.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/docs/learn/beginner/01-tx-lifecycle.md
[style] ~101-~101: Consider a more concise word here.
Context: ...]byte form and needs to be unmarshaled in order to be processed. Then, the [runTx`](../ad...
(IN_ORDER_TO_PREMIUM)
docs/architecture/adr-045-check-delivertx-middlewares.md
[style] ~67-~67: Did you mean ‘different from’? ‘Different than’ is often considered colloquial style.
Context: ...oritization, its signature is different than DeliverTx and SimulateTx. BaseApp hold...
(DIFFERENT_THAN)
docs/architecture/adr-050-sign-mode-textual-annex1.md
[style] ~54-~54: ‘joined together’ might be wordy. Consider a shorter alternative.
Context: ...ncoded as the specification above, then joined together with the delimiter ", " (a comma and ...
(EN_WORDINESS_PREMIUM_JOINED_TOGETHER)
⏰ 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-053-go-module-refactoring.md (1)
99-99: Redundant preposition successfully removed – wording is now clearer
The sentence reads naturally after dropping the extra “in.” No further action needed.docs/spec/README.md (1)
20-20: Typo fix looks good
The correction from “Go the” → “Go to” improves readability and clarity.docs/spec/addresses/bech32.md (1)
21-21: Grammar correction acknowledged
Changing “will sufficient” → “will be sufficient” fixes the sentence. No further issues.docs/docs/learn/learn.md (1)
6-6: Bullet-point spacing fixed
The removed extra space aligns this list with the others; good catch.docs/docs/learn/intro/01-why-app-specific.md (1)
63-63: Redundant term removed
Dropping the duplicate “BFT” after “CometBFT” eliminates redundancy. Looks correct.docs/docs/user/run-node/01-run-node.md (1)
53-53: Grammatical tweak looks good.The adjustment from “Few examples…” to “A few examples…” improves readability and is correct. No further action needed.
docs/docs/learn/intro/02-sdk-app-architecture.md (1)
87-87: Extra period successfully removed.The sentence now flows correctly. ✅
docs/rfc/PROCESS.md (1)
17-17: Typo fixed, good catch.Switching “bi-product” → “by-product” is correct.
docs/architecture/adr-047-extend-upgrade-plan.md (1)
129-130: Minor wording improvement looks goodThe change to “identifying” clarifies the sentence and aligns with standard phrasing.
2 participants
Description
Fix various grammatical errors, terminology inconsistencies, and phrasing issues across multiple ADR documents to improve readability and technical accuracy. Changes include correcting preposition usage, fixing redundant words, ensuring consistent naming of modules and tools, and improving clarity of technical descriptions
Summary by CodeRabbit