docs: fix typos #23105
docs: fix typos #23105
Conversation
chloefeal
requested review from
testinginprod,
kocubinski,
a team,
julienrbrt,
hieuvubk and
facundomedica
as code owners
📝 WalkthroughWalkthroughThis pull request encompasses documentation improvements and minor typographical corrections across multiple files in the Cosmos SDK. The changes primarily focus on enhancing the clarity and accuracy of documentation in the Changes
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
|
github-actions
bot
added
C:collections
C:server/v2
![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 (2)
collections/README.md (1)
822-822: Remove stray line numberThere appears to be a stray line number "822~" in the middle of the documentation text.
server/v2/stf/README.md (1)
34-34: Fix typos and improve writing styleThe sentence contains several typos and can be made more concise.
-THe wrapGasMeter is used in order to consume gas. Application developers can seamlsessly replace the gas meter with their own implementation in order to customize consumption of gas. +The wrapGasMeter is used to consume gas. Application developers can seamlessly replace the gas meter with their own implementation to customize gas consumption.🧰 Tools
🪛 LanguageTool
[style] ~34-~34: Consider a shorter alternative to avoid wordiness.
Context: ...iterMap ) ``` THe wrapGasMeter is used in order to consume gas. Application developers can...(IN_ORDER_TO_PREMIUM)
[style] ~34-~34: Consider a shorter alternative to avoid wordiness.
Context: ...gas meter with their own implementation in order to customize consumption of gas.(IN_ORDER_TO_PREMIUM)
📜 Review details
Configuration used: .coderabbit.yml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
collections/README.md(1 hunks)runtime/v2/manager.go(1 hunks)server/v2/stf/README.md(1 hunks)types/module/module.go(2 hunks)
✅ Files skipped from review due to trivial changes (2)
- types/module/module.go
- runtime/v2/manager.go
🧰 Additional context used
📓 Path-based instructions (2)
collections/README.md (1)
Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"
server/v2/stf/README.md (1)
Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"
🪛 LanguageTool
server/v2/stf/README.md
[style] ~34-~34: Consider a shorter alternative to avoid wordiness.
Context: ...iterMap ) ``` THe wrapGasMeter is used in order to consume gas. Application developers can...
(IN_ORDER_TO_PREMIUM)
[style] ~34-~34: Consider a shorter alternative to avoid wordiness.
Context: ...gas meter with their own implementation in order to customize consumption of gas.
(IN_ORDER_TO_PREMIUM)
🔇 Additional comments (1)
collections/README.md (1)
Line range hint 1-1000: Documentation is comprehensive and well-structured
The documentation provides clear explanations and examples for all collection types, their usage, and best practices. The structure flows logically from basic to advanced concepts.
🧰 Tools
🪛 LanguageTool
[style] ~820-~820: Often, this adverbial phrase is redundant. Consider using an alternative.
Context: ...oto3" json:"sequence,omitempty"` } ``` First of all, when we save our accounts in state we ...
(FIRST_OF_ALL)
Description
This pull request contains changes to improve clarity, correctness and structure.
Description correction: typo fix.
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...
!in the type prefix if API or client breaking changeCHANGELOG.mdReviewers 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...
Summary by CodeRabbit
Documentation
collectionslibrary documentation with detailed explanations and examples for various collection types, includingIndexedMapandTriple.RunMigrationsfunction andwrapGasMeterfunction in the documentation.Bug Fixes
RunMigrationsfunction across multiple files.