docs: typos #25062
docs: typos #25062
Conversation
📝 WalkthroughWalkthroughA series of documentation files were updated to correct typographical and grammatical errors, including function names, terminology, pronoun agreement, and spelling. One change also corrected a receiver type name in a method signature within documentation. No functional code or logic was affected by these changes. 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-045-check-delivertx-middlewares.md (1)
67-67: Prefer “different from” over “different than” for formal consistencyMinor style nit: in technical documentation, “different from” is generally preferred to “different than”.
-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/architecture/adr-049-state-sync-hooks.md (1)
142-142: Tighten wording for clarity and concisionThe sentence is correct but a bit verbose and contains a couple of style redundancies (“are able to”, “outside of”). Consider the edit below to streamline the phrasing and improve readability.
-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 snapshot streams for state maintained outside the IAVL tree—such as CosmWasm blobs. New clients can fetch these snapshots for all modules that implement the corresponding interface from peer nodes.docs/architecture/adr-046-module-params.md (1)
145-147: Typo fixed, but tweak wording for smoother grammarNice catch on
methods👏. While you’re here, the phrase “persistence logics” reads awkwardly—“logic” is normally uncountable.- developers are required to implement persistence logics of module parameters. + developers are required to implement persistence logic for module parameters.docs/architecture/adr-038-state-listening.md (1)
530-533: Typo fix approved; minor grammar polish suggestedThe rename to
RegisterStreamingPluginaligns the prose with the code snippets—nice catch.
While you’re touching this sentence, a small article is missing (“a helper function”).-Note that `RegisterStreamingPlugin` function -is helper function and not a requirement. +Note that the `RegisterStreamingPlugin` function +is a helper function and not a requirement.docs/architecture/adr-050-sign-mode-textual-annex1.md (1)
281-282: Typo fixed, but consider singular verb
While the spelling correction of “invertibility” is correct, the phrase now reads “Data … are not rendered”. If you prefer the more modern singular usage of data, you could changearetois:-Note: Data longer than 35 bytes are not rendered … +Note: Data longer than 35 bytes is not rendered …Purely stylistic—feel free to ignore.
📜 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-038-state-listening.md(1 hunks)docs/architecture/adr-039-epoched-staking.md(1 hunks)docs/architecture/adr-040-storage-and-smt-state-commitments.md(2 hunks)docs/architecture/adr-045-check-delivertx-middlewares.md(1 hunks)docs/architecture/adr-046-module-params.md(1 hunks)docs/architecture/adr-049-state-sync-hooks.md(1 hunks)docs/architecture/adr-050-sign-mode-textual-annex1.md(2 hunks)docs/architecture/adr-050-sign-mode-textual-annex2.md(1 hunks)docs/architecture/adr-050-sign-mode-textual.md(4 hunks)docs/architecture/adr-054-semver-compatible-modules.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
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-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)
docs/architecture/adr-039-epoched-staking.md
[style] ~48-~48: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...thub.com/tendermint/spec/issues/199). * For fairness of deterministic leader electi...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
docs/architecture/adr-050-sign-mode-textual.md
[style] ~14-~14: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...022: Re-ordering of envelope screens. * Dec 14, 2022: Mention exceptions for invert...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
⏰ 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-039-epoched-staking.md (1)
48-48: Correct plural pronoun — good catch.The update from “themself” to “themselves” fixes pronoun-number agreement and improves readability. No further changes required.
docs/architecture/adr-040-storage-and-smt-state-commitments.md (2)
20-21: Correct spelling improves technical accuracy – looks good.The change from “Merkelized” to “Merkleized” aligns with the standard terminology for Merkle trees. No further action required.
33-34: Typo fix acknowledged.“compute-optimized” is the preferred American spelling; change is appropriate and consistent with the rest of the document.
docs/architecture/adr-054-semver-compatible-modules.md (1)
647-649: Typo correction in receiver name – looks goodThe receiver now correctly reads
IntegrationTestConfig, matching the struct definition and allowing the sample to compile without errors. No further issues found in this snippet.docs/architecture/adr-050-sign-mode-textual-annex2.md (1)
80-84: Correct typo – good catch
Replacing “chacters” with “characters” improves clarity; no further action required.docs/architecture/adr-050-sign-mode-textual-annex1.md (1)
352-354: Heading correction looks good
“Best Practices” is now spelled correctly.docs/architecture/adr-050-sign-mode-textual.md (3)
14-15: Changelog entry fixed
“Invertibility” spelling is now consistent with the rest of the document.
208-210: Minor wording tweak approved
The corrected “Tip” field comment reads cleanly; nothing else to address here.
288-300: Bulk typo cleanup acknowledged
All occurrences of “invertability” have been replaced by “invertibility” and prose tightened—thanks for the precision.
|
@CreeptoGengar conflicts |
|
@aljo242 resolved, all good now |
2 participants
Summary by CodeRabbit