docs: fix some markdown syntax #20432
Conversation
WalkthroughWalkthroughThe recent update focuses on correcting a typographical error in the documentation file 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: 1
Outside diff range and nitpick comments (3)
docs/learn/advanced/08-events.md (3)
Line range hint
29-29: Consider using a more formal verb to enhance the professionalism of the documentation.- A list of `attributes` are key-value pairs that give more information about the categorized Event. + A list of `attributes` are key-value pairs that provide more information about the categorized Event.
Line range hint
58-58: Ensure all single quotes are paired to maintain proper formatting in the documentation.- `message.action='/cosmos.bank.v1beta1.Msg/Send'` + `message.action='/cosmos.bank.v1beta1.Msg/Send'`
Line range hint
158-158: Correct the verb form for grammatical accuracy.- `Baseapp` only emits that event if the module have not already done so. + `Baseapp` only emits that event if the module has not already done so.
Review Details
Configuration used: .coderabbit.yml
Review profile: CHILL
Files selected for processing (2)
- docs/learn/advanced/00-baseapp.md (2 hunks)
- docs/learn/advanced/08-events.md (1 hunks)
Additional Context Used
LanguageTool (68)
docs/learn/advanced/00-baseapp.md (58)
Near line 58: “to the” seems less likely than “to”.
Context: ...ed, only the most important ones. Refer to the > type definition for the full list. F...
Near line 63: Loose punctuation mark.
Context: ...iStore`](./04-store.md#commitmultistore): This is the main store of the applicati...
Near line 71: Consider a shorter alternative to avoid wordiness.
Context: ...at needs to be processed by a service in order to update the application state, and not t...
Near line 71: Possible missing comma found.
Context: ... the application state, and not to ABCI message which implements the interface betwee...
Near line 76: Loose punctuation mark.
Context: ...b.com/cosmos/cosmos-sdk/types#TxDecoder): It is used to decode raw transaction ...
Near line 78: Loose punctuation mark.
Context: ... engine. *AnteHandler: This handler is used to handle signatur...
Near line 81: Loose punctuation mark.
Context: .../beginner/00-app-anatomy.md#initchainer), [PreBlocker](../beginner/00-app-anato...
Near line 87: Loose punctuation mark.
Context: ...s) (i.e. cached states): *checkState: This state is updated during [CheckTx...
Near line 88: Loose punctuation mark.
Context: ...ommit](#commit). *finalizeBlockState: This state is updated during [Finalize...
Near line 90: Loose punctuation mark.
Context: ...FinalizeBlock. *processProposalState: This state is updated during [ProcessP...
Near line 91: Loose punctuation mark.
Context: ...cess-proposal). *prepareProposalState: This state is updated during [`PrepareP...
Near line 95: Loose punctuation mark.
Context: ...ore important parameters: *voteInfos: This parameter carries the list of vali...
Near line 99: Loose punctuation mark.
Context: ...hing absent validators. *minGasPrices: This parameter defines the minimum gas ...
Near line 106: Loose punctuation mark.
Context: ...n1uatomOR1photon). *appVersion: Version of the application. It is set i...
Near line 151: ‘off of’ might be wordy. Consider a shorter alternative.
Context: ...ckTx, thecheckState`, which is based off of the last committed state from the root ...
Near line 175: ‘off of’ might be wordy. Consider a shorter alternative.
Context: ...theprocessProposalStateis set based off of the last committed state from the root...
Near line 177: Use a comma before “and” if it connects two independent clauses (unless they are closely connected and short).
Context: ...called and theAnteHandleris executed and the context used in this state is built...
Near line 187: ‘off of’ might be wordy. Consider a shorter alternative.
Context: ...lock. ThefinalizeBlockStateis based off of the last committed state from the root ...
Near line 215: Consider a shorter alternative to avoid wordiness.
Context: ...ust be routed to the appropriate module in order to be processed. Routing is done via `Base...
Near line 219: 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: ...holds amsgServiceRouterwhich maps fully-qualified service methods (string`, defined in e...
Near line 227: 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: ...grpcQueryRouter, which maps modules' fully-qualified service methods (string, defined in t...
Near line 265: Possible missing comma found.
Context: ...osalcomplements theProcessProposal` method which is executed after this method. Th...
Near line 269: Loose punctuation mark.
Context: ...e response contains: *Txs ([][]byte): List of transactions which will form a ...
Near line 283: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...cept a proposal by an honest proposer. It's important to note that `ProcessPropos...
Near line 288: Possible missing comma found.
Context: ...ectly coding these methods could affect liveness as CometBFT is unable to receive 2/3 va...
Near line 292: Loose punctuation mark.
Context: ...e contains: *Status (ProposalStatus): Status of the proposal processing wher...
Near line 327: Consider a shorter alternative to avoid wordiness.
Context: ...t based on the raw transaction size, in order to avoid spam with transactions that provi...
Near line 340: This adverb was used twice in the sentence. Consider removing one of them or replacing them with a synonym.
Context: ...y pay the fees until the transaction is actually included in a block, because `checkStat...
Near line 340: If the ‘because’ clause is essential to the meaning, do not use a comma before the clause.
Context: ...nsaction is actually included in a block, becausecheckStatenever gets committed to th...
Near line 341: The plural noun “blocks” cannot be used with the article “a”. Did you mean “a block” or “blocks”?
Context: ...atest state of the main state each time a blocks gets committed.CheckTxr...
Near line 346: Loose punctuation mark.
Context: ...he response contains: *Code (uint32): Response Code.0if successful. * `Da...
Near line 347: Loose punctuation mark.
Context: ...de.0if successful. *Data ([]byte): Result bytes, if any. *Log (string):...
Near line 348: To form a complete sentence, be sure to include a subject.
Context: ...The output of the application's logger. May be non-deterministic. * `Info (string):...
Near line 349: To form a complete sentence, be sure to include a subject.
Context: ...Info (string):Additional information. May be non-deterministic. *GasWanted (int...
Near line 350: Loose punctuation mark.
Context: ...non-deterministic. *GasWanted (int64): Amount of gas requested for transaction...
Near line 351: Loose punctuation mark.
Context: ...ate the transaction. *GasUsed (int64): Amount of gas consumed by transaction. ...
Near line 357: Loose punctuation mark.
Context: ...c.go#L102 ``` *Events ([]cmn.KVPair): Key-Value tags for filtering and indexi...
Near line 357: The abbreviation “e.g.” (= for example) requires two periods.
Context: ...or filtering and indexing transactions (eg. by account). See [events](./08-events...
Near line 358: Loose punctuation mark.
Context: ...nts.md) for more. *Codespace (string): Namespace for the Code. #### RecheckTx...
Near line 397: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: ...r` is theoretically optional, but still a very important component of public blockchain networks...
Near line 411: 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: ...s. First, it retrieves thesdk.Msg's fully-qualified type name, by checking thetype_urlo...
Near line 415: Consider a shorter alternative to avoid wordiness.
Context: ... receives theResultof theRunMsgsin order to enable this customizable behavior. Lik...
Near line 431: This phrase is redundant. Consider writing “started”.
Context: ...lying CometBFT engine when the chain is first started. It is mainly used to initialize pa...
Near line 437: Consider a shorter alternative to avoid wordiness.
Context: ...tomy.md#initchainer) of the application in order to initialize the main state of the applic...
Near line 465: Did you mean to use ‘who’s’ here (the contracted form of ‘who’ and ‘is/has’)?
Context: ...pplication, i.e. the list of validators whose precommit for the previous block was ...
Near line 477: ‘exact same’ might be wordy. Consider a shorter alternative.
Context: ...n withinFinalizeBlockperforms the exact same steps asCheckTx, with a little cav...
Near line 492: Loose punctuation mark.
Context: ...he response contains: *Code (uint32): Response Code.0if successful. * `Da...
Near line 493: Loose punctuation mark.
Context: ...de.0if successful. *Data ([]byte): Result bytes, if any. *Log (string):...
Near line 494: To form a complete sentence, be sure to include a subject.
Context: ...The output of the application's logger. May be non-deterministic. * `Info (string):...
Near line 495: To form a complete sentence, be sure to include a subject.
Context: ...Info (string):Additional information. May be non-deterministic. *GasWanted (int...
Near line 496: Loose punctuation mark.
Context: ...non-deterministic. *GasWanted (int64): Amount of gas requested for transaction...
Near line 497: Loose punctuation mark.
Context: ...ate the transaction. *GasUsed (int64): Amount of gas consumed by transaction. ...
Near line 498: Loose punctuation mark.
Context: ... store occurs. *Events ([]cmn.KVPair): Key-Value tags for filtering and indexi...
Near line 498: The abbreviation “e.g.” (= for example) requires two periods.
Context: ...or filtering and indexing transactions (eg. by account). See [events](./08-events...
Near line 499: Loose punctuation mark.
Context: ...nts.md) for more. *Codespace (string): Namespace for the Code. #### EndBlock ...
Near line 525: 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: ... to query. If thepathmatches a gRPC fully-qualified service method, thenBaseAppwill def...
Near line 533: Use a comma before “and” if it connects two independent clauses (unless they are closely connected and short).
Context: ...rocess does NOT have to be deterministic and the data returned can be unique to the ...
Near line 545: Possible missing comma found.
Context: ...itted Application state. In the Cosmos-SDK this is implemented as a NoOp: ```go r...docs/learn/advanced/08-events.md (10)
Near line 29: Consider using a more formal verb to strengthen your wording.
Context: ...fattributesare key-value pairs that give more information about the categorized ...
Near line 58: Unpaired symbol: ‘'’ seems to be missing
Context: ... | |message.action='/cosmos.bank.v1beta1.Msg/Send'| Query all transactions containing a ...
Near line 58: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...d'| Query all transactions containing a x/bankSend[ServiceMsg`](../../bui...
Near line 121: Loose punctuation mark.
Context: ... you can subscribe to are: *NewBlock: Contains Events triggered during `Begin...
Near line 122: Loose punctuation mark.
Context: ...ringBeginBlockandEndBlock. *Tx: Contains Events triggered during `Deliv...
Near line 123: Loose punctuation mark.
Context: ...ion processing). *ValidatorSetUpdates: Contains validator set updates for the ...
Near line 151: Loose punctuation mark.
Context: ...ctly frombaseapp. *message.action: The name of the message type. * `messag...
Near line 152: Loose punctuation mark.
Context: ... of the message type. *message.sender: The address of the message signer. * `m...
Near line 153: Loose punctuation mark.
Context: ...f the message signer. *message.module: The name of the module that emitted the...
Near line 158: “Module” is a singular noun. It appears that the verb form is incorrect.
Context: ...pp` only emits that event if the module have not already done so. :::
Path-based Instructions (2)
docs/learn/advanced/08-events.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"docs/learn/advanced/00-baseapp.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"
Additional comments not posted (2)
docs/learn/advanced/08-events.md (1)
7-7: The markdown syntax correction fromevents toeventsis accurate and improves document readability.docs/learn/advanced/00-baseapp.md (1)
357-357: Corrected markdown link syntax fromevents toeventsto ensure proper display.
* 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) ...
Description
the original one separated one word into two. see the below screenshots from cosmos website.
so i fixed the markdown syntax to make the word display properly.
Summary by CodeRabbit
events toeventsfor clarity.