chore: fix all typos #20196
chore: fix all typos #20196
Conversation
WalkthroughWalkthroughThe recent updates across the Changes
Recent Review DetailsConfiguration used: .coderabbit.yml Files selected for processing (1)
Additional Context UsedLanguageTool (107)
Path-based Instructions (1)
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: 4
Out of diff range and nitpick comments (41)
x/params/README.md (6)
Line range hint
7-7: Correct spelling to American English for consistency.- favour + favor
Line range hint
13-13: Add an article for clarity.- Subspace is an isolated namespace for a paramstore + Subspace is an isolated namespace for a paramstore
Line range hint
14-14: Remove unnecessary article.- Keeper has a permission to access all existing spaces. + Keeper has permission to access all existing spaces.
Line range hint
18-18: Consider rephrasing to reduce wordiness.- The params Keeper can be used to add a route to `x/gov` router in order to modify any parameter in case a proposal passes. + The params Keeper can add a route to the `x/gov` router to modify any parameter if a proposal passes.
Line range hint
20-20: Correct verb form to match the subject.- The following contents explains how to use params module for master and user modules. + The following content explains how to use the params module for master and user modules.
Line range hint
32-32: Add a space between sentences for better readability.- Then, those modules can have a reference to their specific parameter store through `Keeper.GetSubspace`. Example: + Then, those modules can have a reference to their specific parameter store through `Keeper.GetSubspace`. Example:docs/architecture/PROCESS.md (2)
Line range hint
11-11: Add a comma for clarity.- If the consensus came from a synchronous discussion then a short excerpt should be added to the ADR to explain the goals. + If the consensus came from a synchronous discussion, then a short excerpt should be added to the ADR to explain the goals.
Line range hint
23-23: Remove extra spaces.- we still prefer to merge it with a _rejected_ status. + we still prefer to merge it with a _rejected_ status.docs/architecture/adr-034-account-rekeying.md (3)
Line range hint
13-13: Correct spelling mistake.- Account rekeying is a process hat allows an account to replace its authentication pubkey with a new one. + Account rekeying is a process that allows an account to replace its authentication pubkey with a new one.
Line range hint
17-17: Use "cannot" for formal writing.- it can not be updated. + it cannot be updated.
Line range hint
46-46: Remove repeated word.- to compensate for this this externality + to compensate for this externalityx/auth/vesting/README.md (4)
Line range hint
9-9: Consider adding the article "a" before "vesting account" for grammatical correctness.
Line range hint
40-40: Consider replacing "is able to" with "can" for conciseness.
Line range hint
40-40: Consider adding a comma after "validators" to correctly separate the clauses.
613-613: Consider starting the sentence with an uppercase letter for consistency.docs/architecture/adr-050-sign-mode-textual.md (16)
Line range hint
6-6: Possible spelling mistake found.Consider changing "concept-ACKed" to "concept-acknowledged" for clarity and formality in documentation.
Line range hint
7-7: Only proper nouns start with an uppercase character (there are exceptions for headlines).Consider changing "Change status to Accepted." to "change status to accepted." to maintain consistency with sentence casing in lists.
Line range hint
8-8: Possible spelling mistake found.Consider changing "tx raw bytes" to "transaction raw bytes" for clarity and to avoid abbreviations in formal documents.
Line range hint
11-11: Possible spelling mistake found.Consider changing "CBOR encoding" to "CBOR Encoding" if referring to a specific standard or technology, otherwise, ensure consistency in capitalization.
Line range hint
14-14: Possible spelling mistake found.Consider changing "invertability" to "invertibility" for correct spelling.
Line range hint
15-15: Add a space between sentences.Consider adding a space after "Title+Content." for better readability.
Line range hint
15-15: Only proper nouns start with an uppercase character (there are exceptions for headlines).Consider changing "Change SignDoc from array to struct containing array." to "change SignDoc from array to struct containing array." to maintain consistency with sentence casing in lists.
Line range hint
30-30: Possible spelling mistake found.Consider changing "SIGN_MODE_DIRECT" to "SignModeDirect" if referring to a code entity, or keep it in quotes if referring to a term.
Line range hint
34-34: This sentence does not start with an uppercase letter.Consider capitalizing the beginning of the sentence: "Hardware cannot decode the protobuf sign bytes due to memory constraints..."
Line range hint
55-55: Possible spelling mistake found.Consider changing "nul" to "null" if referring to the null character, to avoid confusion with a typo.
Line range hint
84-84: The correct preposition here is “on” or “about”.Consider changing "of the original transaction" to "about the original transaction" for grammatical accuracy.
Line range hint
89-89: 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’.Consider changing "cryptographically-strong" to "cryptographically strong" to adhere to grammatical norms regarding hyphenation.
Line range hint
193-193: An accent character was used instead of an apostrophe.Consider changing "don't" to "don't" using the correct apostrophe character for consistency and professionalism in documentation.
Line range hint
226-226: An accent character was used instead of an apostrophe.Consider changing "sdk.Msg's" to "sdk.Msg's" using the correct apostrophe character for consistency and professionalism in documentation.
Line range hint
266-266: Consider changing the order of words to improve your wording.Consider rephrasing "Application developers may choose to not follow default renderer value output for their own
Msgs" to "Application developers may choose not to follow the default renderer value output for their ownMsgs" for smoother readability.
Line range hint
313-313: In this context, ‘type’ should agree in number with the noun after ‘of’.Consider changing "This type of updates require" to "These types of updates require" for grammatical correctness.
docs/architecture/adr-063-core-module-api.md (10)
Line range hint
15-16: Consider revising the sentence for clarity and completeness.- A new core API is proposed as a way to develop cosmos-sdk applications that will eventually replace the existing `AppModule` and `sdk.Context` frameworks a set of core services and extension interfaces. + A new core API is proposed as a way to develop cosmos-sdk applications that will eventually replace the existing `AppModule` and `sdk.Context` frameworks with a set of core services and extension interfaces.
Line range hint
18-18: Start the list with an uppercase letter for consistency.- * be simpler + * Be simpler
Line range hint
23-23: Fix the markdown link to ensure it is correctly formatted.- * [ADR 033: Protobuf-based Inter-Module Communication](./adr-033-protobuf-inter-module-comm.md) clients. + * [ADR 033: Protobuf-based Inter-Module Communication](./adr-033-protobuf-inter-module-comm.md) for clients.
Line range hint
32-32: Consider using a hyphen for the compound adjective "third-party".- * interface methods depend heavily on unstable third party dependencies, in particular Comet, + * interface methods depend heavily on unstable third-party dependencies, in particular Comet,
Line range hint
37-37: Start the list with an uppercase letter for consistency.- * get store keys from the app + * Get store keys from the app
Line range hint
63-63: Start the list with an uppercase letter for consistency.- * everything that a module wants to interact with in the state machine is a service + * Everything that a module wants to interact with in the state machine is a service
Line range hint
70-70: Consider using a hyphen for the compound adjective "non-stable".- * the core API doesn't implement *any* functionality, it just defines types with specific non-stable versions of third party dependencies such as Comet + * the core API doesn't implement *any* functionality, it just defines types with specific non-stable versions of third-party dependencies such as Comet
Line range hint
195-195: Specify the language for the code block to enhance readability and syntax highlighting.- ```go + ```go
Line range hint
222-222: Replace hard tabs with spaces to maintain consistency in indentation across the document.- <hard tab>type AppModule interface { + type AppModule interface {
Line range hint
73-73: Ensure URLs are linked properly in markdown.- * [ADR 033: Protobuf-based Inter-Module Communication](./adr-033-protobuf-inter-module-comm.md) clients. + * [ADR 033: Protobuf-based Inter-Module Communication](./adr-033-protobuf-inter-module-comm.md) clients.
| * Modules can now implement `appmodule.HasRegisterInterfaces`, `module.HasGRPCGateway` and `module.HasAminoCodec` when relevant. | ||
| * SDK modules now directly implement those extension interfaces on `AppModule` instead of `AppModuleBasic`. |
There was a problem hiding this comment.
Correct the indentation of the unordered list items to improve readability and maintain consistency.
- * Modules can now implement `appmodule.HasRegisterInterfaces`, `module.HasGRPCGateway` and `module.HasAminoCodec` when relevant.
- * SDK modules now directly implement those extension interfaces on `AppModule` instead of `AppModuleBasic`.
+ * Modules can now implement `appmodule.HasRegisterInterfaces`, `module.HasGRPCGateway` and `module.HasAminoCodec` when relevant.
+ * SDK modules now directly implement those extension interfaces on `AppModule` instead of `AppModuleBasic`.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.
| * Modules can now implement `appmodule.HasRegisterInterfaces`, `module.HasGRPCGateway` and `module.HasAminoCodec` when relevant. | |
| * SDK modules now directly implement those extension interfaces on `AppModule` instead of `AppModuleBasic`. | |
| * Modules can now implement `appmodule.HasRegisterInterfaces`, `module.HasGRPCGateway` and `module.HasAminoCodec` when relevant. | |
| * SDK modules now directly implement those extension interfaces on `AppModule` instead of `AppModuleBasic`. |
| @@ -76,4 +76,4 @@ Modules often define parameters as a proto message. The generated struct can imp | |||
| * `KeyTable.RegisterParamSet()`: registers all parameters in the struct | |||
| * `Subspace.{Get, Set}ParamSet()`: Get to & Set from the struct | |||
|
|
|||
| The implementor should be a pointer in order to use `GetParamSet()`. | |||
| The implementer should be a pointer in order to use `GetParamSet()`. | |||
There was a problem hiding this comment.
Consider rephrasing to reduce wordiness.
- The implementer should be a pointer in order to use `GetParamSet()`.
+ The implementer should be a pointer to use `GetParamSet()`.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.
| The implementer should be a pointer in order to use `GetParamSet()`. | |
| The implementer should be a pointer to use `GetParamSet()`. |
| @@ -48,7 +48,7 @@ Ref: https://keepachangelog.com/en/1.0.0/ | |||
|
|
|||
| ### API Breaking Changes | |||
|
|
|||
| * [#16008](https://github.com/cosmos/cosmos-sdk/pull/16008) NewKeeper now takes in a KVStoreService instead of KVStoreKey, most functions use context.Context instead of sdk.Context and `IterateEvidence` callback function now returns an error to stop interation (`errors.ErrStopIterating`). | |||
| * [#16008](https://github.com/cosmos/cosmos-sdk/pull/16008) NewKeeper now takes in a KVStoreService instead of KVStoreKey, most functions use context.Context instead of sdk.Context and `IterateEvidence` callback function now returns an error to stop iteration (`errors.ErrStopIterating`). | |||
There was a problem hiding this comment.
Add a space between sentences for better readability.
- most functions use context.Context instead of sdk.Context and `IterateEvidence` callback function now returns an error to stop iteration (`errors.ErrStopIterating`).
+ most functions use context.Context instead of sdk.Context, and `IterateEvidence` callback function now returns an error to stop iteration (`errors.ErrStopIterating`).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.
| * [#16008](https://github.com/cosmos/cosmos-sdk/pull/16008) NewKeeper now takes in a KVStoreService instead of KVStoreKey, most functions use context.Context instead of sdk.Context and `IterateEvidence` callback function now returns an error to stop iteration (`errors.ErrStopIterating`). | |
| * [#16008](https://github.com/cosmos/cosmos-sdk/pull/16008) NewKeeper now takes in a KVStoreService instead of KVStoreKey, most functions use context.Context instead of sdk.Context, and `IterateEvidence` callback function now returns an error to stop iteration (`errors.ErrStopIterating`). |
| @@ -48,7 +48,7 @@ | |||
|
|
|||
| ### API Breaking Changes | |||
|
|
|||
| * [#16008](https://github.com/cosmos/cosmos-sdk/pull/16008) NewKeeper now takes in a KVStoreService instead of KVStoreKey, most functions use context.Context instead of sdk.Context and `IterateEvidence` callback function now returns an error to stop interation (`errors.ErrStopIterating`). | |||
| * [#16008](https://github.com/cosmos/cosmos-sdk/pull/16008) NewKeeper now takes in a KVStoreService instead of KVStoreKey, most functions use context.Context instead of sdk.Context and `IterateEvidence` callback function now returns an error to stop iteration (`errors.ErrStopIterating`). | |||
| * (keeper) [#15825](https://github.com/cosmos/cosmos-sdk/pull/15825) Evidence constructor now requires an `address.Codec` (`import "cosmossdk.io/core/address"`) | |||
| * [#16336](https://github.com/cosmos/cosmos-sdk/pull/16336) Use collections for state management: | |||
| * Removed: keeper `SetEvidence`, `GetEvidence`, `IterateEvidences`, `GetAllEvidences`, `MustMarshalEvidence`, `MustUnmarshalEvidence`, `MarshalEvidence`, `UnmarshalEvidence` | |||
There was a problem hiding this comment.
Correct indentation for unordered list items.
- * Removed: keeper `SetEvidence`, `GetEvidence`, `IterateEvidences`, `GetAllEvidences`, `MustMarshalEvidence`, `MustUnmarshalEvidence`, `MarshalEvidence`, `UnmarshalEvidence`
+ * Removed: keeper `SetEvidence`, `GetEvidence`, `IterateEvidences`, `GetAllEvidences`, `MustMarshalEvidence`, `MustUnmarshalEvidence`, `MarshalEvidence`, `UnmarshalEvidence`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.
| * Removed: keeper `SetEvidence`, `GetEvidence`, `IterateEvidences`, `GetAllEvidences`, `MustMarshalEvidence`, `MustUnmarshalEvidence`, `MarshalEvidence`, `UnmarshalEvidence` | |
| * Removed: keeper `SetEvidence`, `GetEvidence`, `IterateEvidences`, `GetAllEvidences`, `MustMarshalEvidence`, `MustUnmarshalEvidence`, `MarshalEvidence`, `UnmarshalEvidence` |
There was a problem hiding this comment.
Actionable comments posted: 2
Out of diff range and nitpick comments (1)
x/authz/README.md (1)
Line range hint
9-9: Capitalize the first letter of the sentence.- `x/authz` is an implementation of a Cosmos SDK module, per [ADR 30](https://github.com/cosmos/cosmos-sdk/blob/main/docs/architecture/adr-030-authz-module.md), that allows + `X/authz` is an implementation of a Cosmos SDK module, per [ADR 30](https://github.com/cosmos/cosmos-sdk/blob/main/docs/architecture/adr-030-authz-module.md), that allows
| @@ -98,7 +98,7 @@ https://github.com/cosmos/cosmos-sdk/blob/v0.47.0-rc1/x/staking/types/authz.go#L | |||
|
|
|||
| In order to prevent DoS attacks, granting `StakeAuthorization`s with `x/authz` incurs gas. `StakeAuthorization` allows you to authorize another account to delegate, undelegate, or redelegate to validators. The authorizer can define a list of validators they allow or deny delegations to. The Cosmos SDK iterates over these lists and charge 10 gas for each validator in both of the lists. | |||
|
|
|||
| Since the state maintaining a list for granter, grantee pair with same expiration, we are iterating over the list to remove the grant (in case of any revoke of paritcular `msgType`) from the list and we are charging 20 gas per iteration. | |||
| Since the state maintaining a list for granter, grantee pair with same expiration, we are iterating over the list to remove the grant (in case of any revoke of particular `msgType`) from the list and we are charging 20 gas per iteration. | |||
There was a problem hiding this comment.
Clarify the sentence structure and add a comma for better readability.
- Since the state maintaining a list for granter, grantee pair with same expiration, we are iterating over the list to remove the grant (in case of any revoke of particular `msgType`) from the list and we are charging 20 gas per iteration.
+ Since the state maintains a list for each granter-grantee pair with the same expiration, we iterate over the list to remove the grant (in case of any revoke of a particular `msgType`) from the list, and we charge 20 gas per iteration.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.
| Since the state maintaining a list for granter, grantee pair with same expiration, we are iterating over the list to remove the grant (in case of any revoke of particular `msgType`) from the list and we are charging 20 gas per iteration. | |
| Since the state maintains a list for each granter-grantee pair with the same expiration, we iterate over the list to remove the grant (in case of any revoke of a particular `msgType`) from the list, and we charge 20 gas per iteration. |
| @@ -124,7 +124,7 @@ | |||
| https://github.com/cosmos/cosmos-sdk/blob/5f4ddc6f80f9707320eec42182184207fff3833a/x/authz/keeper/keeper.go#L378-L403 | |||
| ``` | |||
|
|
|||
| * GrantQueue: `0x02 | expiration_bytes | granter_address_len (1 byte) | granter_address_bytes | grantee_address_len (1 byte) | grantee_address_bytes -> ProtocalBuffer(GrantQueueItem)` | |||
| * GrantQueue: `0x02 | expiration_bytes | granter_address_len (1 byte) | granter_address_bytes | grantee_address_len (1 byte) | grantee_address_bytes -> ProtocolBuffer(GrantQueueItem)` | |||
There was a problem hiding this comment.
Correct the date format in the comment to match standard ISO 8601 format.
- The `expiration_bytes` are the expiration date in UTC with the format `"2006-01-02T15:04:05.000000000"`.
+ The `expiration_bytes` are the expiration date in UTC with the format `"YYYY-MM-DDTHH:MM:SS.sssZ"`.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.
| * GrantQueue: `0x02 | expiration_bytes | granter_address_len (1 byte) | granter_address_bytes | grantee_address_len (1 byte) | grantee_address_bytes -> ProtocolBuffer(GrantQueueItem)` | |
| * GrantQueue: `0x02 | expiration_bytes | granter_address_len (1 byte) | granter_address_bytes | grantee_address_len (1 byte) | grantee_address_bytes -> ProtocolBuffer(GrantQueueItem)` | |
| - The `expiration_bytes` are the expiration date in UTC with the format `"YYYY-MM-DDTHH:MM:SS.sssZ"`. |
Description
This PR will fix all typos in current repo.
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
cosmos-sdk, now directly implementing extension interfaces onAppModule.