Skip to content

Commit 46a7f91

Browse files
viktorking7aljo242
andauthored
fix: spelling/grammar across docs and tooling (#25677)
Co-authored-by: Alex | Cosmos Labs <[email protected]>
1 parent 8fb7b4b commit 46a7f91

File tree

21 files changed

+34
-35
lines changed

21 files changed

+34
-35
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ The Cosmos SDK is a modular, open-source blockchain SDK for building secure, hig
2828

2929
The Cosmos SDK is tailored for building secure, sovereign application-specific blockchains. Developers building with the Cosmos SDK can use predefined modules that cover standard blockchain functionality or create custom modules for their specific use case. This composable architecture enables robust customization. The SDK provides abstractions for permissioning, governance, state management, account abstraction, tokenization processes, application logic, and more.
3030

31-
Cosmos SDK blockchains get interoperability out-of-the-box via a native integration with the [Inter-Blockchain Communication Protocol (IBC)](https://github.com/cosmos/ibc-go). Ibc-go is implemented as a Go module in the Cosmos SDK.
31+
Cosmos SDK blockchains get interoperability out-of-the-box via a native integration with the [Inter-Blockchain Communication Protocol (IBC)](https://github.com/cosmos/ibc-go). ibc-go is implemented as a Go module in the Cosmos SDK.
3232

3333
While the Cosmos SDK is plug-and-play with any consensus engine, we recommend using [CometBFT](https://github.com/cometbft/cometbft) for a fast, battle-tested, high-throughput, configurable BFT state machine. CometBFT is developed as part of the Cosmos Stack and its releases are updated alongside the SDK.
3434

client/debug/main.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ func PubkeyCmd() *cobra.Command {
104104
return &cobra.Command{
105105
Use: "pubkey [pubkey]",
106106
Short: "Decode a pubkey from proto JSON",
107-
Long: fmt.Sprintf(`Decode a pubkey from proto JSON and display it's address.
107+
Long: fmt.Sprintf(`Decode a pubkey from proto JSON and display its address.
108108
109109
Example:
110110
$ %s debug pubkey '{"@type":"/cosmos.crypto.secp256k1.PubKey","key":"AurroA7jvfPd1AadmmOvWM2rJSwipXfRf8yD6pLbA2DJ"}'

collections/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ var (
122122

123123
#### Rules
124124

125-
``collections.NewPrefix`` accepts either `uint8`, `string` or `[]bytes` it's good practice to use an always increasing `uint8`for disk space efficiency.
125+
``collections.NewPrefix`` accepts either `uint8`, `string` or `[]bytes` it's good practice to use an always increasing `uint8` for disk space efficiency.
126126

127127
A collection **MUST NOT** share the same prefix as another collection in the same module, and a collection prefix **MUST NEVER** start with the same prefix as another, examples:
128128

@@ -397,7 +397,7 @@ func (k Keeper) RemoveValidator(ctx sdk.Context, validator sdk.ValAddress) error
397397
}
398398
```
399399

400-
The first difference we notice is that `KeySet` needs use to specify only one type parameter: the key (`sdk.ValAddress` in this case).
400+
The first difference we notice is that `KeySet` needs us to specify only one type parameter: the key (`sdk.ValAddress` in this case).
401401
The second difference we notice is that `KeySet` in its `NewKeySet` function does not require
402402
us to specify a `ValueCodec` but only a `KeyCodec`. This is because a `KeySet` only saves keys and not values.
403403

@@ -605,7 +605,7 @@ we specified in the range.
605605
Then we use again the `Values` method of the `Iterator` to collect all the results.
606606

607607
`collections.Range` also offers a `Prefix` API which is not applicable to all keys types,
608-
for example uint64 cannot be prefix because it is of constant size, but a `string` key
608+
for example uint64 cannot be prefixed because it is of constant size, but a `string` key
609609
can be prefixed.
610610

611611
#### IterateAccounts
@@ -648,7 +648,7 @@ Let's see now how we can work with composite keys using collections.
648648

649649
### Example
650650

651-
In our example we will show-case how we can use collections when we are dealing with balances, similar to bank,
651+
In our example we will showcase how we can use collections when we are dealing with balances, similar to bank,
652652
a balance is a mapping between `(address, denom) => math.Int` the composite key in our case is `(address, denom)`.
653653

654654
## Instantiation of a composite key collection

contrib/x/group/internal/orm/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ A table can be built given a `codec.ProtoMarshaler` model type, a prefix to acce
2424
https://github.com/cosmos/cosmos-sdk/tree/release/v0.50.x/x/group/internal/orm/table.go#L30-L36
2525
```
2626

27-
In the prefix store, entities should be stored by an unique identifier called `RowID` which can be based either on an `uint64` auto-increment counter, string or dynamic size bytes.
27+
In the prefix store, entities should be stored by a unique identifier called `RowID` which can be based either on a `uint64` auto-increment counter, string or dynamic size bytes.
2828
Regular CRUD operations can be performed on a table, these methods take a `sdk.KVStore` as parameter to get the table prefix store.
2929

3030
The `table` struct does not:

contrib/x/group/internal/orm/table.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ var (
2121
)
2222

2323
// table is the high level object to storage mapper functionality. Persistent
24-
// entities are stored by an unique identifier called `RowID`. The table struct
24+
// entities are stored by a unique identifier called `RowID`. The table struct
2525
// does not:
2626
// - enforce uniqueness of the `RowID`
2727
// - enforce prefix uniqueness of keys, i.e. not allowing one key to be a prefix

docs/architecture/adr-040-storage-and-smt-state-commitments.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -192,7 +192,7 @@ The presented workaround can be used until the IBC module is fully upgraded to s
192192

193193
We consider a compression of prefix keys by creating a mapping from module key to an integer, and serializing the integer using varint coding. Varint coding assures that different values don't have common byte prefix. For Merkle Proofs we can't use prefix compression - so it should only apply for the `SS` keys. Moreover, the prefix compression should be only applied for the module namespace. More precisely:
194194

195-
* each module has it's own namespace;
195+
* each module has its own namespace;
196196
* when accessing a module namespace we create a KVStore with embedded prefix;
197197
* that prefix will be compressed only when accessing and managing `SS`.
198198

@@ -279,7 +279,7 @@ We were discussing use case where modules can use a support database, which is n
279279
## References
280280

281281
* [IAVL What's Next?](https://github.com/cosmos/cosmos-sdk/issues/7100)
282-
* [IAVL overview](https://docs.google.com/document/d/16Z_hW2rSAmoyMENO-RlAhQjAG3mSNKsQueMnKpmcBv0/edit#heading=h.yd2th7x3o1iv) of it's state v0.15
282+
* [IAVL overview](https://docs.google.com/document/d/16Z_hW2rSAmoyMENO-RlAhQjAG3mSNKsQueMnKpmcBv0/edit#heading=h.yd2th7x3o1iv) of its state v0.15
283283
* [State commitments and storage report](https://paper.dropbox.com/published/State-commitments-and-storage-review--BDvA1MLwRtOx55KRihJ5xxLbBw-KeEB7eOd11pNrZvVtqUgL3h)
284284
* [Celestia (LazyLedger) SMT](https://github.com/lazyledger/smt)
285285
* Facebook Diem (Libra) SMT [design](https://developers.diem.com/papers/jellyfish-merkle-tree/2021-01-14.pdf)

docs/architecture/adr-048-consensus-fees.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ This ADR describes a flexible mechanism to maintain a consensus level gas prices
1414

1515
## Context
1616

17-
Currently, each validator configures it's own `minimal-gas-prices` in `app.yaml`. But setting a proper minimal gas price is critical to protect network from dos attack, and it's hard for all the validators to pick a sensible value, so we propose to maintain a gas price in consensus level.
17+
Currently, each validator configures its own `minimal-gas-prices` in `app.yaml`. But setting a proper minimal gas price is critical to protect network from DoS attack, and it's hard for all the validators to pick a sensible value, so we propose to maintain a gas price in consensus level.
1818

1919
Since tendermint 0.34.20 has supported mempool prioritization, we can take advantage of that to implement more sophisticated gas fee system.
2020

docs/architecture/adr-049-state-sync-hooks.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ type ExtensionPayloadReader = func() ([]byte, error)
116116
type ExtensionPayloadWriter = func([]byte) error
117117

118118
// ExtensionSnapshotter is an extension Snapshotter that is appended to the snapshot stream.
119-
// ExtensionSnapshotter has an unique name and manages it's own internal formats.
119+
// ExtensionSnapshotter has a unique name and manages its own internal formats.
120120
type ExtensionSnapshotter interface {
121121
// SnapshotName returns the name of snapshotter, it should be unique in the manager.
122122
SnapshotName() string

docs/architecture/adr-060-abci-1.0.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ transactions entirely with other transactions.
137137

138138
When evaluating transactions from `RequestPrepareProposal`, the application will
139139
ignore *ALL* transactions sent to it in the request and instead reap up to
140-
`RequestPrepareProposal.max_tx_bytes` from it's own mempool.
140+
`RequestPrepareProposal.max_tx_bytes` from its own mempool.
141141

142142
Since an application can technically insert or inject transactions on `Insert`
143143
during `CheckTx` execution, it is recommended that applications ensure transaction

docs/architecture/adr-064-abci-2.0.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -286,7 +286,7 @@ decision based on the vote extensions.
286286
> nor the vote extension verification mechanism described above is required for
287287
> applications to implement. In other words, a proposer is not required to verify
288288
> and propagate vote extensions along with their signatures nor are proposers
289-
> required to verify those signatures. An application can implement it's own
289+
> required to verify those signatures. An application can implement its own
290290
> PKI mechanism and use that to sign and verify vote extensions.
291291
292292
#### Vote Extension Persistence

0 commit comments

Comments
 (0)