docs(x/auth): fixed typo in command example for multisign transaction #20417
Conversation
Corrected the typo in the command example for signing multisign transactions. Changed simd tx multisign to simd tx multi-sign to accurately reflect the correct usage. This ensures the documentation provides the right command syntax for users. Signed-off-by: Hwangjae Lee <meetrick@gmail.com>
WalkthroughWalkthroughThe primary change involves renaming the 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 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 as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
![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
Out of diff range and nitpick comments (7)
x/auth/README.md (7)
Line range hint
40-40: Consider adding a comma for clarity.- actions on behalf of other accounts and enables a granter + actions on behalf of other accounts, and enables a granter
Line range hint
92-92: Consider simplifying the sentence to enhance readability.- Note that all of these methods operate on an account struct conforming to the interface - in order to write the account to the store, the account keeper will need to be used. + Note that these methods operate on an account struct conforming to the interface. To write the account to the store, use the account keeper.
Line range hint
148-148: Simplify the expression for conciseness.- CometBFT proposers presently have the ability to include + CometBFT proposers can include
Line range hint
186-186: Remove the unnecessary hyphen.- fully-permissioned account keeper + fully permissioned account keeper
Line range hint
252-252: Correct the possessive pronoun.- by it's address + by its addressAlso applies to: 491-491, 674-674
Line range hint
403-403: Consider using a more formal expression.- Use directly the `--help` flag + Directly use the `--help` flag
Line range hint
436-436: Correct the plural form for consistency.- into one transactions + into one transaction
Review Details
Configuration used: .coderabbit.yml
Review profile: CHILL
Files selected for processing (1)
- x/auth/README.md (1 hunks)
Additional Context Used
LanguageTool (22)
x/auth/README.md (22)
Near line 40: Possible missing comma found.
Context: ...s to perform actions on behalf of other accounts and enables a granter to grant authoriz...
Near line 92: Consider a shorter alternative to avoid wordiness.
Context: ...nt struct conforming to the interface - in order to write the account to the store, the acc...
Near line 148: The phrase ‘have the ability to’ might be wordy. Consider using “can”.
Context: ...verTx`, as CometBFT proposers presently have the ability to include in their proposed block transac...
Near line 154: Loose punctuation mark.
Context: ...lowing order: *SetUpContextDecorator: Sets theGasMeterin theContextan...
Near line 156: Loose punctuation mark.
Context: ...ed. *RejectExtensionOptionsDecorator: Rejects all extension options which can...
Near line 158: Loose punctuation mark.
Context: ...f transactions. *MempoolFeeDecorator: Checks if thetxfee is above local m...
Near line 160: Loose punctuation mark.
Context: ...gCheckTx. *ValidateBasicDecorator: Callstx.ValidateBasicand returns an...
Near line 162: Loose punctuation mark.
Context: ...nil error. *TxTimeoutHeightDecorator: Check for atxheight timeout. * `Va...
Near line 164: Loose punctuation mark.
Context: ...ight timeout. *ValidateMemoDecorator: Validatestxmemo with application pa...
Near line 166: Loose punctuation mark.
Context: ...il error. *ConsumeGasTxSizeDecorator: Consumes gas proportional to thetxs...
Near line 168: Loose punctuation mark.
Context: ...tion parameters. *DeductFeeDecorator: Deducts theFeeAmountfrom first sign...
Near line 170: Loose punctuation mark.
Context: ...granter account. *SetPubKeyDecorator: Sets the pubkey from atx's signers t...
Near line 172: Loose punctuation mark.
Context: ... context. *ValidateSigCountDecorator: Validates the number of signatures in `...
Near line 174: Loose punctuation mark.
Context: ...-parameters. *SigGasConsumeDecorator: Consumes parameter-defined amount of ga...
Near line 176: Loose punctuation mark.
Context: ...ecorator. *SigVerificationDecorator`: Verifies all signatures are valid. This...
Near line 178: Loose punctuation mark.
Context: ...orator. *IncrementSequenceDecorator`: Increments the account sequence for eac...
Near line 186: Although a hyphen is possible, it is not necessary in a compound modifier in which the first word is an adverb that ends in ‘ly’.
Context: ... ### Account Keeper Presently only one fully-permissioned account keeper is exposed, which has th...
Near line 252: Did you mean “its” (the possessive pronoun)?
Context: ... allow users to query for an account by it's address. ```bash simd query auth accou...
Near line 403: Consider using a more formal alternative.
Context: ... Use directly the--helpflag to get more information about thetxcommand. ```bash simd t...
Near line 436: Please verify that the plural noun “transactions” is in agreement with the quantifier “one”. Did you mean to use the singular form?
Context: ... combining the signed transactions into one transactions, use the--appendflag. More informa...
Near line 491: Did you mean “its” (the possessive pronoun)?
Context: ... allow users to query for an account by it's address. ```bash cosmos.auth.v1beta1.Q...
Near line 674: Did you mean “its” (the possessive pronoun)?
Context: ... allow users to query for an account by it's address. ```bash /cosmos/auth/v1beta1/...
Path-based Instructions (1)
x/auth/README.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"
Additional comments not posted (1)
x/auth/README.md (1)
445-445: The command syntax correction is accurate and aligns with the PR description.
Thanks for feedback |
* main: (95 commits) fix(x/accounts): check for overflows in multisig weights and votes (#20384) docs(x/account/auth): Improve error handling and comments in fee.go (#20426) docs: fix some markdown syntax (#20432) revert: bank change module to account change (#20427) fix: nil pointer panic when store don't exists in historical version (#20425) fix(store/v2): Remove should not error on miss (#20423) chore: upstream more changes from v2 (#20387) docs(x/auth/ante): fixed typo in TxWithTimeoutHeight interface name (#20418) fix: avoid default sendenabled for module accounts (#20419) docs(x/auth): fixed typo in command example for multisign transaction (#20417) build(deps): Bump bufbuild/buf-setup-action from 1.31.0 to 1.32.0 (#20413) build(deps): Bump github.com/hashicorp/go-plugin from 1.6.0 to 1.6.1 in /store (#20414) feat(x/accounts): Add schema caching feature and corresponding test case (#20055) refactor(runtime/v2): remove dependency on sdk (#20389) refactor!: turn MsgsV2 into ReflectMessages to make it less confusing (#19839) docs: Enhanced the ParsePagination method documentation (#20385) refactor(runtime,core): split router service (#20401) chore: fix spelling errors (#20400) docs: Documented error handling in OfferSnapshot method (#20380) build(deps): Bump google.golang.org/grpc from 1.63.2 to 1.64.0 (#20390) ...
Corrected the typo in the command example for signing multisign transactions. Changed simd tx multisign to simd tx multi-sign to accurately reflect the correct usage. This ensures the documentation provides the right command syntax for users.
Description
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
multisigncommand tomulti-signfor better clarity in signing transactions generated offline by a multisig account.