Skip to content

Commit

Permalink
chore: src: fix godoc comments (filecoin-project#12257)
Browse files Browse the repository at this point in the history
  • Loading branch information
polymaer authored Jul 18, 2024
1 parent 2714a84 commit 43b7a78
Show file tree
Hide file tree
Showing 5 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion blockstore/badger/blockstore.go
Original file line number Diff line number Diff line change
Expand Up @@ -1067,7 +1067,7 @@ func (b *Blockstore) PooledStorageKey(cid cid.Cid) (key []byte, pooled bool) {
return k, true // slicing upto length unnecessary; the pool has already done this.
}

// Storage acts like PooledStorageKey, but attempts to write the storage key
// StorageKey acts like PooledStorageKey, but attempts to write the storage key
// into the provided slice. If the slice capacity is insufficient, it allocates
// a new byte slice with enough capacity to accommodate the result. This method
// returns the resulting slice.
Expand Down
2 changes: 1 addition & 1 deletion chain/beacon/mock.go
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ import (
"github.com/filecoin-project/lotus/chain/types"
)

// Mock beacon assumes that filecoin rounds are 1:1 mapped with the beacon rounds
// mockBeacon assumes that filecoin rounds are 1:1 mapped with the beacon rounds
type mockBeacon struct {
interval time.Duration
}
Expand Down
2 changes: 1 addition & 1 deletion cli/util/api.go
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ const (
metadataTraceContext = "traceContext"
)

// GetAPIInfo returns the API endpoint to use for the specified kind of repo.
// GetAPIInfoMulti returns the API endpoints to use for the specified kind of repo.
//
// The order of precedence is as follows:
//
Expand Down
2 changes: 1 addition & 1 deletion cmd/lotus-sim/simulation/node.go
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ func (nd *Node) LoadSim(ctx context.Context, name string) (*Simulation, error) {
return sim, nil
}

// Create creates a new simulation.
// CreateSim creates a new simulation.
//
// - This will fail if a simulation already exists with the given name.
// - Num must not contain a '/'.
Expand Down
2 changes: 1 addition & 1 deletion node/builder.go
Original file line number Diff line number Diff line change
Expand Up @@ -261,7 +261,7 @@ func Base() Option {
)
}

// Config sets up constructors based on the provided Config
// ConfigCommon sets up constructors based on the provided Config
func ConfigCommon(cfg *config.Common, buildVersion build.BuildVersion, enableLibp2pNode bool) Option {
// setup logging early
lotuslog.SetLevelsFromConfig(cfg.Logging.SubsystemLevels)
Expand Down

0 comments on commit 43b7a78

Please sign in to comment.