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 (backport #22976) #22987

Merged
merged 2 commits into from
Dec 18, 2024

Conversation

mergify[bot]
Copy link
Contributor

@mergify mergify bot 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.

This is an automatic backport of pull request #22976 done by [Mergify](https://mergify.com).

…#22976)

(cherry picked from commit 96cfd52)

# Conflicts:
#	docs/architecture/adr-75-v2.md
@mergify mergify bot requested a review from a team as a code owner December 18, 2024 17:21
@mergify mergify bot added the conflicts label Dec 18, 2024
Copy link
Contributor Author

mergify bot commented Dec 18, 2024

Cherry-pick of 96cfd52 has failed:

On branch mergify/bp/release/v0.52.x/pr-22976
Your branch is up to date with 'origin/release/v0.52.x'.

You are currently cherry-picking commit 96cfd521d.
  (fix conflicts and run "git cherry-pick --continue")
  (use "git cherry-pick --skip" to skip this patch)
  (use "git cherry-pick --abort" to cancel the cherry-pick operation)

Changes to be committed:
	modified:   docs/architecture/adr-045-check-delivertx-middlewares.md
	modified:   docs/rfc/rfc-006-handlers.md
	modified:   docs/spec/store/README.md
	modified:   docs/user/run-node/01-run-node.md
	modified:   x/staking/CHANGELOG.md

Unmerged paths:
  (use "git add/rm <file>..." as appropriate to mark resolution)
	deleted by us:   docs/architecture/adr-75-v2.md

To fix up this pull request, you can check it out locally. See documentation: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally

Copy link
Contributor

coderabbitai bot commented Dec 18, 2024

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


🪧 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.

@julienrbrt julienrbrt merged commit 39dfcb5 into release/v0.52.x Dec 18, 2024
11 of 30 checks passed
@julienrbrt julienrbrt deleted the mergify/bp/release/v0.52.x/pr-22976 branch December 18, 2024 17:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants