chore: polish docs and fix grammatical inconsistencies #25163
Conversation
📝 WalkthroughWalkthroughThis PR makes editorial fixes across documentation files: grammar, wording, pluralization, and whitespace normalization. No code, APIs, or functional behavior are changed. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 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. CodeRabbit Commands (Invoked using PR/Issue comments)Type 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 (18)
docs/docs/user/run-node/06-run-production.md (2)
14-14: Tighten wording and fix comma splice.Also addresses the wordiness hint (“many different ways” → “many ways”).
Apply this diff:
-There are many different ways to secure a server and your node, the described steps here are one way. To see another way of setting up a server see the [run in production tutorial](https://tutorials.cosmos.network/hands-on-exercise/4-run-in-prod). +There are many ways to secure a server and your node; the steps described here are one approach. For an alternative setup, see the [run in production tutorial](https://tutorials.cosmos.network/hands-on-exercise/4-run-in-prod).
64-64: Capitalize SSH acronym.Minor consistency improvement.
Apply this diff:
-2. Let's make sure that port 22 (ssh) stays open. +2. Let's make sure that port 22 (SSH) stays open.docs/spec/SPEC_MODULE.md (1)
15-15: Add a comma after “described” for readability.The sentence scans better with the parenthetical clause separated.
Apply this diff:
-the functionality being described pseudo-code may be the most suitable form of +the functionality being described, pseudo-code may be the most suitable form ofdocs/rfc/rfc-001-tx-validation.md (1)
25-25: Smooth grammar: add comma and explicit verb for “fees charged”.Reads more clearly and avoids a fragment.
Apply this diff:
-The consequence of updating the transaction flow is that transactions that may have failed before with the `ValidateBasic` flow will now be included in a block and the fees charged. +The consequence of updating the transaction flow is that transactions that may have failed before with the `ValidateBasic` flow will now be included in a block, and fees will be charged.docs/rfc/README.md (1)
13-13: Tighten antecedent and fix brand capitalization"Google docs" should be "Google Docs". Also, the current "that is difficult to discover" reads as if it modifies "ad‑hoc way" (singular). If the intent is to refer to "gists or Google Docs" (plural), use a plural relative clause for clarity.
- via gists or Google docs) that is difficult to discover for someone after the + via gists or Google Docs) that are difficult to discover for someone after thedocs/spec/addresses/bech32.md (2)
17-17: Hyphenation and plurality in compound modifiers
- Use the hyphenated compound modifier "user-facing".
- "binary value" should be plural.
- Hyphenate "base64-encoded" as a compound modifier.
-While all user facing interfaces to Cosmos software should expose Bech32 interfaces, many internal interfaces encode binary value in hex or base64 encoded form. +While all user-facing interfaces to Cosmos software should expose Bech32 interfaces, many internal interfaces encode binary values in hex or base64-encoded form.
19-19: Remove unnecessary “other” for precision"other" is unnecessary and slightly awkward here.
-To convert between other binary representations of addresses and keys, it is important to first apply the Amino encoding process before Bech32 encoding. +To convert between binary representations of addresses and keys, it is important to first apply the Amino encoding process before Bech32 encoding.docs/rfc/PROCESS.md (2)
19-19: Improve flow and pluralityUse "the result" and pluralize "discussion" for parallel structure.
-1. Proposals could start with a new GitHub Issue or be a result of existing Issues or a discussion. +1. Proposals could start with a new GitHub Issue or be the result of existing Issues or discussions.
53-53: Fix idioms and gerund usage; address style hint
- "close to accept" → "close to accepting"
- "give it a time" → "give it time" or "allow time"
-* `LAST CALL <date for the last call>`: [optional] clearly notify that we are close to accept updates. Changing a status to `LAST CALL` means that social consensus (of Cosmos SDK maintainers) has been reached and we still want to give it a time to let the community react or analyze. +* `LAST CALL <date for the last call>`: [optional] clearly notify that we are close to accepting updates. Changing a status to `LAST CALL` means that social consensus (of Cosmos SDK maintainers) has been reached and we still want to give it time to let the community react or analyze.docs/spec/_ics/ics-030-signed-messages.md (1)
25-25: Subject–verb agreement in “include … but are not limited to”When using "include," the idiomatic continuation is "but are not limited to".
-applications of signing such data include, but is not limited to, providing a +applications of signing such data include, but are not limited to, providing adocs/spec/store/interblock-cache.md (3)
31-31: Punctuation: add comma after e.g.Standard style is "e.g., ..." with a trailing comma.
-This is data that does not change often, e.g. module parameters. The inter-block cache wraps each `CommitKVStore` of a multi store such as `rootmulti` with a fixed size, write-through cache. +This is data that does not change often, e.g., module parameters. The inter-block cache wraps each `CommitKVStore` of a multi store such as `rootmulti` with a fixed size, write-through cache.
50-50: Code span punctuationThe period should be outside the inline code span.
-* `Get(key string)` attempts to retrieve a key/value pair from `Cache.` It returns `(value []byte, success bool)`. If `Cache` contains the key, then `value` contains the associated value and `success=true`. Otherwise, `success=false` and `value` should be ignored. +* `Get(key string)` attempts to retrieve a key/value pair from `Cache`. It returns `(value []byte, success bool)`. If `Cache` contains the key, then `value` contains the associated value and `success=true`. Otherwise, `success=false` and `value` should be ignored.
132-132: Clarify phrasing in the API table entry"any" is ambiguous; "one" reads better, and "cache map" is more concise.
-| store | `CommitKVStore` | The store that is cached in case the manager does not have any in its map of caches | +| store | `CommitKVStore` | The store that is cached if the manager does not yet have one in its cache map |docs/README.md (3)
26-26: Avoid double-trigger phrasing; clarify the condition.The current sentence reads like two separate triggers. Tighten it to reflect that pushes trigger builds when docs/specs are modified.
Apply this diff:
-The workflow is triggered on every push to the `main` and `release/v**` branches, every time documentation or specs are modified. +The workflow is triggered on pushes to the `main` and `release/v**` branches when documentation or specs are modified.
50-52: Use “redirects” and tighten sentences.Minor readability/terminology improvements.
Apply this diff:
-Note, the command above only builds the docs for the current versions. -With the drawback that none of the redirections work. So, you'll need to go to /main to see the docs. +Note: The command above only builds the current documentation version. +As a result, redirects do not work. Navigate to /main to view the docs.
78-78: Preposition nit: “to” reads more naturally here.Apply this diff:
-* Add the new version in `presets[1].docs.versions` in `docusaurus.config.js`. +* Add the new version to `presets[1].docs.versions` in `docusaurus.config.js`.docs/spec/store/README.md (2)
32-35: Optional: expand OCAP on first mention for clarity.Acronym expansion improves readability for unfamiliar readers.
Apply this diff:
-`KVStoreKey`. The `KVStoreKey` provides pseudo-OCAP. How exactly a `KVStoreKey` +`KVStoreKey`. The `KVStoreKey` provides pseudo-OCAP (object-capability). How exactly a `KVStoreKey`
118-119: Minor grammar nits around article/comma and redundancy.
- Prefer “an
iavl.Store” (vowel sound) and add a comma after it.- Consider dropping the repeated word “store” in “The
cachekv.Storestore...”.Example revision (includes adjacent line for completeness):
The `cachekv.Store` wraps an underlying `KVStore`, typically an `iavl.Store`, and contains an in-memory cache for storing pending writes to the underlying `KVStore`.
📜 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 (12)
docs/DOC_WRITING_GUIDELINES.md(1 hunks)docs/README.md(3 hunks)docs/docs/user/run-node/06-run-production.md(2 hunks)docs/rfc/PROCESS.md(3 hunks)docs/rfc/README.md(1 hunks)docs/rfc/rfc-001-tx-validation.md(1 hunks)docs/spec/README.md(1 hunks)docs/spec/SPEC_MODULE.md(1 hunks)docs/spec/_ics/ics-030-signed-messages.md(2 hunks)docs/spec/addresses/bech32.md(1 hunks)docs/spec/store/README.md(3 hunks)docs/spec/store/interblock-cache.md(4 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/docs/user/run-node/06-run-production.md
[style] ~14-~14: ‘many different ways’ might be wordy. Consider a shorter alternative.
Context: ...server up securely. :::note There are many different ways to secure a server and your node, the d...
(EN_WORDINESS_PREMIUM_MANY_DIFFERENT_WAYS)
docs/rfc/PROCESS.md
[style] ~53-~53: Consider replacing ‘give’ with a different word to let your writing stand out.
Context: ...) has been reached and we still want to give it a time to let the community react or an...
(GIVE_TIME_STYLE)
⏰ 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 (4)
docs/spec/README.md (1)
18-18: Good fix: singular “Module specifications” reads better.Change improves grammar and consistency with the surrounding headings.
docs/spec/store/interblock-cache.md (1)
86-86: LGTM on “composed of”"composed of" is the correct idiom here. Nice catch.
docs/README.md (1)
59-59: LGTM — clearer heading.The revised heading is grammatically correct and clearer.
docs/spec/store/README.md (1)
197-198: LGTM — improved clarity.The phrasing “to its respective
KVStoreinstance” reads well.
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
|
CI is failing |
Pull request was closed
2 participants
Description
Correct various grammatical errors, spelling mistakes, subject-verb agreement issues, and punctuation errors throughout documentation files.
Summary by CodeRabbit