Skip to content

Commit 3881dae

Browse files
authored
enhance codebase clarity through systematic terminology corrections (#24975)
1 parent 283a1de commit 3881dae

File tree

13 files changed

+14
-14
lines changed

13 files changed

+14
-14
lines changed

baseapp/abci_utils_test.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -657,7 +657,7 @@ func (s *ABCIUtilsTestSuite) TestDefaultProposalHandler_PriorityNonceMempoolTxSe
657657
expectedTxs: []int{9},
658658
},
659659
"no txs added": {
660-
// Becasuse the first tx was deemed valid but too big, the next expected valid sequence is tx[0].seq (3), so
660+
// Because the first tx was deemed valid but too big, the next expected valid sequence is tx[0].seq (3), so
661661
// the rest of the txs fail because they have a seq of 4.
662662
ctx: s.ctx,
663663
txInputs: []testTx{testTxs[12], testTxs[13], testTxs[14]},

baseapp/baseapp.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ type BaseApp struct {
121121
// ResponseCommit.RetainHeight value during ABCI Commit. A value of 0 indicates
122122
// that no blocks should be pruned.
123123
//
124-
// Note: CometBFT block pruning is dependant on this parameter in conjunction
124+
// Note: CometBFT block pruning is dependent on this parameter in conjunction
125125
// with the unbonding (safety threshold) period, state pruning and state sync
126126
// snapshot parameters to determine the correct minimum value of
127127
// ResponseCommit.RetainHeight.

baseapp/test_helpers.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ func (app *BaseApp) SimTxFinalizeBlock(txEncoder sdk.TxEncoder, tx sdk.Tx) (sdk.
5252
}
5353

5454
// SimWriteState is an entrypoint for simulations only. They are not executed during the normal ABCI finalize
55-
// block step but later. Therefor an extra call to the root multi-store (app.cms) is required to write the changes.
55+
// block step but later. Therefore an extra call to the root multi-store (app.cms) is required to write the changes.
5656
func (app *BaseApp) SimWriteState() {
5757
app.stateManager.GetState(execModeFinalize).MultiStore.Write()
5858
}

docs/architecture/adr-037-gov-split-vote.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Changelog
44

5-
* 2020/10/28: Intial draft
5+
* 2020/10/28: Initial draft
66

77
## Status
88

docs/architecture/adr-063-core-module-api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -199,7 +199,7 @@ func NewKeeper(logger log.Logger) Keeper {
199199
200200
Modules will provide their core services to the runtime module via extension interfaces built on top of the
201201
`cosmossdk.io/core/appmodule.AppModule` tag interface. This tag interface requires only two empty methods which
202-
allow `depinject` to identify implementors as `depinject.OnePerModule` types and as app module implementations:
202+
allow `depinject` to identify implementers as `depinject.OnePerModule` types and as app module implementations:
203203
204204
```go
205205
type AppModule interface {

docs/rfc/PROCESS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ DRAFT -> PROPOSED -> LAST CALL yyyy-mm-dd -> ACCEPTED | REJECTED -> SUPERSEDED b
5353
* `LAST CALL <date for the last call>`: [optional] clear notify that we are close to accept updates. Changing a status to `LAST CALL` means that social consensus (of Cosmos SDK maintainers) has been reached and we still want to give it a time to let the community react or analyze.
5454
* `ACCEPTED`: ADR which will represent a currently implemented or to be implemented architecture design.
5555
* `REJECTED`: ADR can go from PROPOSED or ACCEPTED to rejected if the consensus among project stakeholders will decide so.
56-
* `SUPERSEEDED by ADR-xxx`: ADR which has been superseded by a new ADR.
56+
* `SUPERSEDED by ADR-xxx`: ADR which has been superseded by a new ADR.
5757
* `ABANDONED`: the ADR is no longer pursued by the original authors.
5858

5959
## Language used in RFC

docs/rfc/rfc-001-tx-validation.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
## Background
88

9-
Transation Validation is crucial to a functioning state machine. Within the Cosmos SDK there are two validation flows, one is outside the message server and the other within. The flow outside of the message server is the `ValidateBasic` function. It is called in the antehandler on both `CheckTx` and `DeliverTx`. There is an overhead and sometimes duplication of validation within these two flows. This extra validation provides an additional check before entering the mempool.
9+
Transaction Validation is crucial to a functioning state machine. Within the Cosmos SDK there are two validation flows, one is outside the message server and the other within. The flow outside of the message server is the `ValidateBasic` function. It is called in the antehandler on both `CheckTx` and `DeliverTx`. There is an overhead and sometimes duplication of validation within these two flows. This extra validation provides an additional check before entering the mempool.
1010

1111
With the deprecation of [`GetSigners`](https://github.com/cosmos/cosmos-sdk/issues/11275) we have the optionality to remove [sdk.Msg](https://github.com/cosmos/cosmos-sdk/blob/16a5404f8e00ddcf8857c8a55dca2f7c109c29bc/types/tx_msg.go#L16) and the `ValidateBasic` function.
1212

@@ -16,7 +16,7 @@ With the separation of CometBFT and Cosmos-SDK, there is a lack of control of wh
1616

1717
The acceptance of this RFC would move validation within `ValidateBasic` to the message server in modules, update tutorials and docs to remove mention of using `ValidateBasic` in favour of handling all validation for a message where it is executed.
1818

19-
We can and will still support the `Validatebasic` function for users and provide an extension interface of the function once `sdk.Msg` is depreacted.
19+
We can and will still support the `Validatebasic` function for users and provide an extension interface of the function once `sdk.Msg` is deprecated.
2020

2121
> Note: This is how messages are handled in VMs like Ethereum and CosmWasm.
2222

docs/rfc/rfc-template.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232
> path and fall into the same pitfalls that we've since matured from. Abandoned ideas are a way to recognize that path
3333
> and explain the pitfalls and why they were abandoned.
3434
35-
## Descision
35+
## Decision
3636

3737
> This section describes alternative designs to the chosen design. This section
3838
> is important and if an adr does not have any alternatives then it should be

types/address_test.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -428,7 +428,7 @@ func (s *addressTestSuite) TestCustomAddressVerifier() {
428428
return fmt.Errorf("incorrect address length %d", n)
429429
})
430430

431-
// Verifiy that the custom logic rejects this 10 byte address
431+
// Verify that the custom logic rejects this 10 byte address
432432
err = types.VerifyAddressFormat(addr)
433433
s.Require().NotNil(err)
434434
_, err = types.AccAddressFromBech32(accBech)

types/denom.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ func GetDenomUnit(denom string) (math.LegacyDec, bool) {
4747
return unit, true
4848
}
4949

50-
// SetBaseDenom allow overwritting the base denom
50+
// SetBaseDenom allow overwriting the base denom
5151
// if the denom has registered before, otherwise return error
5252
func SetBaseDenom(denom string) error {
5353
_, ok := denomUnits[denom]

0 commit comments

Comments
 (0)