chore: fix a number of typos #18680
Closed
chore: fix a number of typos #18680
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
WalkthroughWalkthroughThe changes across various documentation files primarily consist of typo corrections, language clarifications, and minor updates to descriptions and comments. These alterations improve the readability and accuracy of the documentation but do not affect the logic, control flow, or declarations of exported or public entities within the Cosmos SDK. Changes
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 X ? TipsChat with CodeRabbit Bot (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Review Status
Actionable comments generated: 2
Configuration used: CodeRabbit UI
Files selected for processing (17)
- docs/architecture/adr-018-extendable-voting-period.md (1 hunks)
- docs/architecture/adr-032-typed-events.md (1 hunks)
- docs/architecture/adr-034-account-rekeying.md (3 hunks)
- docs/architecture/adr-041-in-place-store-migrations.md (1 hunks)
- docs/architecture/adr-048-consensus-fees.md (1 hunks)
- docs/architecture/adr-050-sign-mode-textual-annex1.md (2 hunks)
- docs/architecture/adr-050-sign-mode-textual.md (5 hunks)
- docs/architecture/adr-062-collections-state-layer.md (1 hunks)
- docs/architecture/adr-063-core-module-api.md (1 hunks)
- docs/build/building-modules/01-module-manager.md (1 hunks)
- docs/build/building-modules/02-messages-and-queries.md (1 hunks)
- docs/learn/advanced/01-transactions.md (1 hunks)
- docs/learn/advanced/02-context.md (1 hunks)
- docs/learn/advanced/05-encoding.md (1 hunks)
- docs/learn/advanced/11-runtx_middleware.md (1 hunks)
- docs/rfc/PROCESS.md (2 hunks)
- docs/rfc/rfc-template.md (1 hunks)
Files skipped from review due to trivial changes (11)
- docs/architecture/adr-018-extendable-voting-period.md
- docs/architecture/adr-034-account-rekeying.md
- docs/architecture/adr-048-consensus-fees.md
- docs/architecture/adr-050-sign-mode-textual.md
- docs/architecture/adr-062-collections-state-layer.md
- docs/architecture/adr-063-core-module-api.md
- docs/build/building-modules/02-messages-and-queries.md
- docs/learn/advanced/02-context.md
- docs/learn/advanced/05-encoding.md
- docs/rfc/PROCESS.md
- docs/rfc/rfc-template.md
Additional comments: 7
docs/architecture/adr-032-typed-events.md (1)
- 23-27: The added context provides valuable insight into the practical application of typed events by the Akash Network team. It's well-integrated into the existing document and enhances the reader's understanding of the motivation behind the proposal.
docs/architecture/adr-041-in-place-store-migrations.md (1)
- 134-137: The changes made to the documentation clarify the upgrade process, specifically detailing the actions of the old and new binaries at block
Nand the migration of module stores. This aligns with the PR's objective to fix typographical errors and improve clarity in documentation.docs/architecture/adr-050-sign-mode-textual-annex1.md (2)
272-278: The clarification on the handling of byte arrays and the reasoning behind the chosen number 35 enhances the understanding of the document. This change aligns with the PR's objective of correcting typographical errors and improving documentation clarity.
346-352: The typo correction and the added recommendation for the use of
msg_titleoption are appropriate. They contribute to the document's accuracy and provide valuable guidance for future message naming conventions.docs/build/building-modules/01-module-manager.md (1)
- 276-276: The added description for the
NewBasicManagerFromManagerfunction is clear and enhances the documentation by explaining the purpose of the function and how it relates to theManagerandAppModuleBasic. The use of markdown formatting with backticks for function names and types is correct and improves readability.docs/learn/advanced/01-transactions.md (1)
- 82-87: The description of
SIGN_MODE_DIRECT_AUXis clear and provides a good explanation of its purpose and functionality. However, ensure that the version number (v0.46) mentioned is accurate and consistent with the actual release of this feature in the Cosmos SDK.
The verification confirms the accuracy of the version number (v0.46) mentioned in the documentation for
SIGN_MODE_DIRECT_AUX. No issues found.docs/learn/advanced/11-runtx_middleware.md (1)
- 7-9: The added explanation about
BaseApp.runTx()handling Go panics is clear and informative. It correctly describes the functionality and the use of recovery middleware.
| @@ -81,7 +81,7 @@ The Cosmos SDK also provides a couple of other sign modes for particular use cas | |||
|
|
|||
| #### `SIGN_MODE_DIRECT_AUX` | |||
|
|
|||
| `SIGN_MODE_DIRECT_AUX` is a sign mode released in the Cosmos SDK v0.46 which targets transactions with multiple signers. Whereas `SIGN_MODE_DIRECT` expects each signer to sign over both `TxBody` and `AuthInfo` (which includes all other signers' signer infos, i.e. their account sequence, public key and mode info), `SIGN_MODE_DIRECT_AUX` allows N-1 signers to only sign over `TxBody` and _their own_ signer info. Morever, each auxiliary signer (i.e. a signer using `SIGN_MODE_DIRECT_AUX`) doesn't | |||
| `SIGN_MODE_DIRECT_AUX` is a sign mode released in the Cosmos SDK v0.46 which targets transactions with multiple signers. Whereas `SIGN_MODE_DIRECT` expects each signer to sign over both `TxBody` and `AuthInfo` (which includes all other signers' signer infos, i.e. their account sequence, public key and mode info), `SIGN_MODE_DIRECT_AUX` allows N-1 signers to only sign over `TxBody` and _their own_ signer info. Moreover, each auxiliary signer (i.e. a signer using `SIGN_MODE_DIRECT_AUX`) doesn't | |||
| need to sign over the fees: | |||
There was a problem hiding this comment.
There is a typographical error with an extra space in the word "need" which should be corrected for consistency and readability.
- need to sign over the fees:
+ need to sign over the fees:Committable suggestion
❗ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
Suggested change
| need to sign over the fees: | |
| need to sign over the fees: |
| @@ -81,7 +81,7 @@ | |||
|
|
|||
| #### `SIGN_MODE_DIRECT_AUX` | |||
|
|
|||
| `SIGN_MODE_DIRECT_AUX` is a sign mode released in the Cosmos SDK v0.46 which targets transactions with multiple signers. Whereas `SIGN_MODE_DIRECT` expects each signer to sign over both `TxBody` and `AuthInfo` (which includes all other signers' signer infos, i.e. their account sequence, public key and mode info), `SIGN_MODE_DIRECT_AUX` allows N-1 signers to only sign over `TxBody` and _their own_ signer info. Morever, each auxiliary signer (i.e. a signer using `SIGN_MODE_DIRECT_AUX`) doesn't | |||
| `SIGN_MODE_DIRECT_AUX` is a sign mode released in the Cosmos SDK v0.46 which targets transactions with multiple signers. Whereas `SIGN_MODE_DIRECT` expects each signer to sign over both `TxBody` and `AuthInfo` (which includes all other signers' signer infos, i.e. their account sequence, public key and mode info), `SIGN_MODE_DIRECT_AUX` allows N-1 signers to only sign over `TxBody` and _their own_ signer info. Moreover, each auxiliary signer (i.e. a signer using `SIGN_MODE_DIRECT_AUX`) doesn't | |||
| need to sign over the fees: | |||
|
|
|||
| ```protobuf reference | |||
There was a problem hiding this comment.
The hunk mentions SIGN_MODE_TEXTUAL but does not provide a description of it. It would be beneficial for readers if a brief explanation of SIGN_MODE_TEXTUAL and its advantages or use cases were included.
|
Hi, thank you! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Fix a number of typos in docs
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.
I have...
Summary by CodeRabbit