Skip to content

Commit 4c9687a

Browse files
authored
fix(docs): minor godoc corrections (#12843)
Signed-off-by: petercover <[email protected]>
1 parent 364cc76 commit 4c9687a

File tree

4 files changed

+6
-6
lines changed

4 files changed

+6
-6
lines changed

api/api_full.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1164,7 +1164,7 @@ type ChannelAvailableFunds struct {
11641164
// QueuedAmt is the amount that is queued up behind a pending request
11651165
QueuedAmt types.BigInt
11661166

1167-
// VoucherRedeemedAmt is the amount that is redeemed by vouchers on-chain
1167+
// VoucherReedeemedAmt is the amount that is redeemed by vouchers on-chain
11681168
// and in the local datastore
11691169
VoucherReedeemedAmt types.BigInt
11701170
}

cli/mocks_test.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ import (
1111
"github.com/filecoin-project/lotus/api/mocks"
1212
)
1313

14-
// newMockAppWithFullAPI returns a gomock-ed CLI app used for unit tests
14+
// NewMockAppWithFullAPI returns a gomock-ed CLI app used for unit tests
1515
// see cli/util/api.go:GetFullNodeAPI for mock API injection
1616
func NewMockAppWithFullAPI(t *testing.T, cmd *ucli.Command) (*ucli.App, *mocks.MockFullNode, *bytes.Buffer, func()) {
1717
app := ucli.NewApp()

itests/splitstore_test.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -386,7 +386,7 @@ func NewGarbager(ctx context.Context, t *testing.T, n *kit.TestFullNode) *Garbag
386386
return g
387387
}
388388

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

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

406-
// exists checks whether the cid is reachable through the node
406+
// Exists checks whether the cid is reachable through the node
407407
func (g *Garbager) Exists(ctx context.Context, c cid.Cid) bool {
408408
// check chain get / blockstore get
409409
_, err := g.node.ChainReadObj(ctx, c)

storage/pipeline/fsm.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -847,7 +847,7 @@ func planOne(ts ...func() (mut mutator, next func(*SectorInfo) (more bool, err e
847847
}
848848
}
849849

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

0 commit comments

Comments
 (0)