docs: fix typos

[oliveredget]

Description

This PR focuses on correcting typos and improving clarity in documentation files.

Thank you very much.

Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

• included the correct type prefix in the PR title, you can find examples of the prefixes below:
• confirmed ! in the type prefix if API or client breaking change
• targeted the correct branch (see PR Targeting)
• provided a link to the relevant issue or specification
• reviewed "Files changed" and left comments if necessary
• included the necessary unit and integration tests
• added a changelog entry to CHANGELOG.md
• updated the relevant documentation or specification, including comments for documenting Go code
• confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

Please see Pull Request Reviewer section in the contributing guide for more information on how to review a pull request.

I have...

• confirmed the correct type prefix in the PR title
• confirmed all author checklist items have been addressed
• reviewed state machine logic, API design and naming, documentation is accurate, tests and test coverage

Summary by CodeRabbit

• Documentation
  • Corrected terminology in the lockup account module documentation
  • Fixed spelling of "notBondedLockedAmount" for improved clarity and consistency
  • Enhanced readability of slashing event descriptions without changing underlying logic

[coderabbitai]

📝 Walkthrough

Walkthrough

The pull request focuses on correcting terminology in the x/accounts/defaults/lockup/README.md documentation. The primary change involves fixing the term "notBondedLockedAmout" to "notBondedLockedAmount" throughout the document. This correction aims to improve clarity and consistency in the explanation of lockup account types and slashing event handling. No changes were made to the underlying logic or functionality of the code.

Changes

File	Change Summary
x/accounts/defaults/lockup/README.md	Corrected terminology from "notBondedLockedAmout" to "notBondedLockedAmount"

Possibly related PRs

• docs(x/accounts/defaults/lockup): Add slash document for lockup account #22783: Adds a section on slashing in the x/accounts/defaults/lockup/README.md
• docs: fix typos #23116: Corrects remaingSlashAmount to remainingSlashAmount in x/staking/README.md
• docs: Fix typo in x/slashing/README.md #23107: Fixes MissedBloskCounter to MissedBlocksCounter in x/slashing/README.md

Suggested labels

C:x/accounts/lockup, backport/v0.52.x

Suggested reviewers

• sontrinh16
• testinginprod
• julienrbrt
• akhilkumarpilli
• lucaslopezf

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

x/accounts/defaults/lockup/README.md (2)

121-125: Fix punctuation and formatting inconsistencies

1. Add a comma after the formula for better readability
2. Maintain consistent bullet point formatting

-`notBondedLockedAmount` can only be 0 or a positive value when `DelegatedLockedAmount` < `LockedAmount`. Let call
+`notBondedLockedAmount` can only be 0 or a positive value when `DelegatedLockedAmount` < `LockedAmount`. Let's call

-    * When not applying slash  `notBondedLockedAmount` will be 0 
-    * When apply slash `notBondedLockedAmount` will be `lockedAmount` - `NewDelegatedLockedAmount` =  a positive amount
+* When not applying slash, `notBondedLockedAmount` will be 0 
+* When applying slash, `notBondedLockedAmount` will be `lockedAmount` - `NewDelegatedLockedAmount` = a positive amount

🧰 Tools

🪛 LanguageTool

[uncategorized] ~121-~121: Possible missing comma found.
Context: ...mount, delegatedLockedAmount) As seen in the formulanotBondedLockedAmount` can...

(AI_HYDRA_LEO_MISSING_COMMA)

---

128-129: Improve formula readability and consistency

The formula explanation would be clearer with proper spacing and consistent terminology.

-    * When apply slash `notBondedLockedAmount` will be `lockedAmount` - `NewDelegatedLockedAmount` = `lockedAmount` - `(DelegatedLockedAmount - N)` = `lockedAmount` - `DelegatedLockedAmount` + N 
+    * When applying slash, `notBondedLockedAmount` will be:
+      `lockedAmount` - `NewDelegatedLockedAmount` = `lockedAmount` - (`DelegatedLockedAmount` - N) = `lockedAmount` - `DelegatedLockedAmount` + N

📜 Review details

Configuration used: .coderabbit.yml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5a9b265 and 7b4aebb.

📒 Files selected for processing (1)

• x/accounts/defaults/lockup/README.md (1 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

x/accounts/defaults/lockup/README.md (1)

Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"

🪛 LanguageTool

x/accounts/defaults/lockup/README.md

[uncategorized] ~121-~121: Possible missing comma found.
Context: ...mount, delegatedLockedAmount) As seen in the formulanotBondedLockedAmount` can...

(AI_HYDRA_LEO_MISSING_COMMA)

🔇 Additional comments (1)

x/accounts/defaults/lockup/README.md (1)

Line range hint 1-129: Documentation changes look good!

The documentation effectively explains the lockup account types and slashing behavior. The examples are comprehensive and technically accurate.

🧰 Tools

🪛 LanguageTool

[uncategorized] ~121-~121: Possible missing comma found.
Context: ...mount, delegatedLockedAmount) As seen in the formulanotBondedLockedAmount` can...

(AI_HYDRA_LEO_MISSING_COMMA)