Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(docs): fix incorrect usage of 'a' and 'an' across documentation #22976

Merged
merged 6 commits into from
Dec 18, 2024

Conversation

vipocenka
Copy link
Contributor

@vipocenka vipocenka commented Dec 18, 2024

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:

  • Used the correct type prefix (chore) in the PR title.
  • Targeted the correct branch as per contribution guidelines.
  • Included a changelog entry to document changes.
  • Confirmed that all CI checks have passed.

Reviewer Checklist:

  • Verified the correct use of the type prefix in the PR title.
  • Ensured all grammatical issues addressed in the listed files are resolved.
  • Confirmed that the changelog entry is appropriately updated.

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

    • Introduced pre and post message handlers for improved module development.
    • Enhanced modularity with the transition to Cosmos SDK version 2.
    • Added new metadata type in the staking module for validator details.
  • Bug Fixes

    • Resolved issues preventing overslashing of unbonding delegations.
    • Fixed errors in the GetLastValidators function.
  • Improvements

    • Updated error handling to return errors instead of logging.
    • Enhanced documentation for clarity and usability across various sections.
  • API Breaking Changes

    • Significant alterations in method signatures and return types across multiple modules.
  • State Breaking Changes

    • Removed certain keys from storage and updated initialization functions.
  • Documentation

    • Updated various documents to improve clarity and provide additional guidance for users.

Copy link
Contributor

coderabbitai bot commented Dec 18, 2024

📝 Walkthrough

Walkthrough

This 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

File Change Summary
docs/architecture/adr-045-check-delivertx-middlewares.md Documented abandonment of middleware-based design for BaseApp's transaction methods, highlighting complexity concerns
docs/architecture/adr-75-v2.md Outlined architectural transition to SDK V2, emphasizing modularity, extensibility, and new execution models
docs/rfc/rfc-006-handlers.md Proposed new pre and post message handlers to improve module development and reduce code duplication
docs/spec/store/README.md Enhanced documentation for store interfaces and types, clarifying state management mechanisms
docs/user/run-node/01-run-node.md Improved node running instructions with more detailed configuration and security guidance
x/staking/CHANGELOG.md Updated changelog with bug fixes, features, improvements, and breaking changes for the staking module

Sequence Diagram

sequenceDiagram
    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
Loading

Possibly related PRs

Suggested Labels

backport/v0.52.x

Suggested Reviewers

  • sontrinh16
  • julienrbrt
  • akhilkumarpilli

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?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (3)
docs/architecture/adr-75-v2.md (1)

203-203: Add a comma for better readability

Add 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 warning

Consider 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 because

Alternatively, 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 clause

Add 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

📥 Commits

Reviewing files that changed from the base of the PR and between ca55998 and ca39b6e.

📒 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: ⚠️ Potential issue

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.

Copy link
Member

@tac0turtle tac0turtle left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thank you

@julienrbrt julienrbrt added the backport/v0.52.x PR scheduled for inclusion in the v0.52's next stable release label Dec 18, 2024
@julienrbrt julienrbrt added this pull request to the merge queue Dec 18, 2024
Merged via the queue into cosmos:main with commit 96cfd52 Dec 18, 2024
73 of 81 checks passed
mergify bot pushed a commit that referenced this pull request Dec 18, 2024
…#22976)

(cherry picked from commit 96cfd52)

# Conflicts:
#	docs/architecture/adr-75-v2.md
julienrbrt added a commit that referenced this pull request Dec 18, 2024
… (backport #22976) (#22987)

Co-authored-by: Ocenka <testoviydiman1@gmail.com>
Co-authored-by: Julien Robert <julien@rbrt.fr>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport/v0.52.x PR scheduled for inclusion in the v0.52's next stable release C:x/staking Type: ADR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants