Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: fix some comments #12843

Merged
merged 1 commit into from
Jan 23, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion api/api_full.go
Original file line number Diff line number Diff line change
Expand Up @@ -1164,7 +1164,7 @@ type ChannelAvailableFunds struct {
// QueuedAmt is the amount that is queued up behind a pending request
QueuedAmt types.BigInt

// VoucherRedeemedAmt is the amount that is redeemed by vouchers on-chain
// VoucherReedeemedAmt is the amount that is redeemed by vouchers on-chain
// and in the local datastore
VoucherReedeemedAmt types.BigInt
}
Expand Down
2 changes: 1 addition & 1 deletion cli/mocks_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import (
"github.com/filecoin-project/lotus/api/mocks"
)

// newMockAppWithFullAPI returns a gomock-ed CLI app used for unit tests
// NewMockAppWithFullAPI returns a gomock-ed CLI app used for unit tests
// see cli/util/api.go:GetFullNodeAPI for mock API injection
func NewMockAppWithFullAPI(t *testing.T, cmd *ucli.Command) (*ucli.App, *mocks.MockFullNode, *bytes.Buffer, func()) {
app := ucli.NewApp()
Expand Down
6 changes: 3 additions & 3 deletions itests/splitstore_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -386,7 +386,7 @@ func NewGarbager(ctx context.Context, t *testing.T, n *kit.TestFullNode) *Garbag
return g
}

// drop returns the cid referencing the dropped garbage and the chain epoch of the drop
// Drop returns the cid referencing the dropped garbage and the chain epoch of the drop
func (g *Garbager) Drop(ctx context.Context) (cid.Cid, abi.ChainEpoch) {
// record existing with mInfoCidAtEpoch
c := g.mInfoCid(ctx)
Expand All @@ -397,13 +397,13 @@ func (g *Garbager) Drop(ctx context.Context) (cid.Cid, abi.ChainEpoch) {
return c, g.newPeerID(ctx)
}

// message returns the cid referencing a message and the chain epoch it went on chain
// Message returns the cid referencing a message and the chain epoch it went on chain
func (g *Garbager) Message(ctx context.Context) (cid.Cid, abi.ChainEpoch) {
mw := g.createMiner(ctx)
return mw.Message, mw.Height
}

// exists checks whether the cid is reachable through the node
// Exists checks whether the cid is reachable through the node
func (g *Garbager) Exists(ctx context.Context, c cid.Cid) bool {
// check chain get / blockstore get
_, err := g.node.ChainReadObj(ctx, c)
Expand Down
2 changes: 1 addition & 1 deletion storage/pipeline/fsm.go
Original file line number Diff line number Diff line change
Expand Up @@ -847,7 +847,7 @@ func planOne(ts ...func() (mut mutator, next func(*SectorInfo) (more bool, err e
}
}

// planOne but ignores unhandled states without erroring, this prevents the need to handle all possible events creating
// planOneOrIgnore but ignores unhandled states without erroring, this prevents the need to handle all possible events creating
// error during forced override
func planOneOrIgnore(ts ...func() (mut mutator, next func(*SectorInfo) (more bool, err error))) func(events []statemachine.Event, state *SectorInfo) (uint64, error) {
f := planOne(ts...)
Expand Down
Loading