chore(docs): fix incorrect usage of 'a' and 'an' across documentation #22976
Conversation
vipocenka
requested review from
a team,
facundomedica,
testinginprod,
JulianToledano and
ziscky
as code owners
📝 WalkthroughWalkthroughThis pull request encompasses multiple documentation updates and architectural decision records (ADRs) for the Cosmos SDK, focusing on middleware design, transaction handling, and module system enhancements. The changes include abandoning ADR 045 for middleware-based transaction processing, introducing a new architectural approach for SDK version 2, proposing pre and post message handlers, and updating documentation for various components like stores, node running, and the staking module. Changes
Sequence DiagramsequenceDiagram
participant Client
participant Middleware
participant Handler
participant Module
Client->>Middleware: Send Transaction
Middleware->>Handler: Pre-process Transaction
Handler->>Module: Execute Transaction
Module-->>Handler: Transaction Result
Handler->>Middleware: Post-process Transaction
Middleware-->>Client: Transaction Response
Possibly related PRs
Suggested Labels
Suggested Reviewers
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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
Documentation and Community
|
![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 (3)
docs/architecture/adr-75-v2.md (1)
203-203: Add a comma for better readabilityAdd a comma after "Baseapp" to separate the two clauses:
-Maintenance cost can be the same as existing Baseapp as handling many go.mods is an overhead. +Maintenance cost can be the same as existing Baseapp, as handling many go.mods is an overhead.🧰 Tools
🪛 LanguageTool
[uncategorized] ~203-~203: Possible missing comma found.
Context: ...enance cost can be the same as existing Baseapp as handling many go.mods is an overhead...(AI_HYDRA_LEO_MISSING_COMMA)
docs/spec/store/README.md (1)
106-106: Enhance visibility of critical warningConsider making the concurrent access warning more prominent by using bold text or a warning block:
-it's being iterated over. Doing so will cause an irrecoverable fatal error because +it's being iterated over. **WARNING**: Doing so will cause an irrecoverable fatal error becauseAlternatively, you could use a warning block:
> ⚠️ **WARNING**: Concurrent iteration and writes will cause an irrecoverable fatal error because of concurrent reads and writes to an internal map.docs/rfc/rfc-006-handlers.md (1)
13-13: Add a comma after the introductory clauseAdd a comma after "While this design is useful" to properly separate the introductory clause from the main clause.
-fulfilled the needs of users today. While this design is useful it has caused an +fulfilled the needs of users today. While this design is useful, it has caused an🧰 Tools
🪛 LanguageTool
[typographical] ~13-~13: Consider adding a comma here.
Context: ...ds of users today. While this design is useful it has caused an elevated learning curv...(IF_THAT_S_NOT_POSSIBLE_COMMA)
📜 Review details
Configuration used: .coderabbit.yml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (6)
docs/architecture/adr-045-check-delivertx-middlewares.md(1 hunks)docs/architecture/adr-75-v2.md(1 hunks)docs/rfc/rfc-006-handlers.md(1 hunks)docs/spec/store/README.md(1 hunks)docs/user/run-node/01-run-node.md(1 hunks)x/staking/CHANGELOG.md(1 hunks)
🧰 Additional context used
📓 Path-based instructions (6)
docs/spec/store/README.md (1)
Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"
docs/user/run-node/01-run-node.md (1)
Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"
docs/architecture/adr-75-v2.md (1)
Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"
docs/architecture/adr-045-check-delivertx-middlewares.md (1)
Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"
docs/rfc/rfc-006-handlers.md (1)
Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"
x/staking/CHANGELOG.md (1)
Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"
🪛 LanguageTool
docs/architecture/adr-75-v2.md
[uncategorized] ~203-~203: Possible missing comma found.
Context: ...enance cost can be the same as existing Baseapp as handling many go.mods is an overhead...
(AI_HYDRA_LEO_MISSING_COMMA)
docs/rfc/rfc-006-handlers.md
[typographical] ~13-~13: Consider adding a comma here.
Context: ...ds of users today. While this design is useful it has caused an elevated learning curv...
(IF_THAT_S_NOT_POSSIBLE_COMMA)
🔇 Additional comments (3)
x/staking/CHANGELOG.md (1)
112-112:
Fix typo in GitHub URL
The organization name in the URL is misspelled. It should be "cosmos" instead of "cosmoc":
-[#20845](https://github.com/cosmoc/cosmos-sdk/pull/20845)
+[#20845](https://github.com/cosmos/cosmos-sdk/pull/20845)Likely invalid or redundant comment.
docs/user/run-node/01-run-node.md (1)
135-135: LGTM: Correct article usage
The use of "an" before "unbounded" is grammatically correct as "unbounded" begins with a vowel sound.
docs/architecture/adr-045-check-delivertx-middlewares.md (1)
21-21: LGTM: Correct article usage
The use of "a" before "naive" is grammatically correct as "naive" begins with a consonant sound.
julienrbrt
added
the
backport/v0.52.x
… (backport #22976) (#22987) Co-authored-by: Ocenka <[email protected]> Co-authored-by: Julien Robert <[email protected]>
This PR addresses several grammatical issues related to the incorrect usage of the indefinite articles "a" and "an" across multiple documentation files. The changes improve clarity and readability by ensuring proper article usage before vowel and consonant sounds.
Closes:
N/A (Please replace with the relevant issue number if applicable)
Files Updated:
docs/architecture/adr-045-check-delivertx-middlewares.md: Changed "An naive solution" to "A naive solution."docs/architecture/adr-75-v2.md: Changed "a overhead" to "an overhead."docs/rfc/rfc-006-handlers.md: Changed "a elevated" to "an elevated."docs/spec/store/README.md: Changed "a irrecoverable" to "an irrecoverable."docs/user/run-node/01-run-node.md: Changed "a unbounded" to "an unbounded."x/staking/CHANGELOG.md: Changed "a undelegation" to "an undelegation."Author Checklist:
chore) in the PR title.Reviewer Checklist:
Additional Notes:
This PR includes small but important documentation fixes to maintain consistency and professionalism in project documentation. Let me know if further changes are required!
Summary by CodeRabbit
New Features
Bug Fixes
GetLastValidatorsfunction.Improvements
API Breaking Changes
State Breaking Changes
Documentation