Skip to content

Commit a2dae25

Browse files
authored
chore: fix some comments to improve readability (#3325)
Signed-off-by: cuoguojida <cuoguojida@outlook.com>
1 parent 27eeb48 commit a2dae25

6 files changed

Lines changed: 7 additions & 8 deletions

File tree

core/execution/execution.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ type Executor interface {
9797
//
9898
// The function marks transaction with a filter status. The sequencer knows how to proceed with it:
9999
// - Transactions passing all filters constraints and that can be included (FilterOK)
100-
// - Invalid/unparseable force-included transactions (gibberish) (FilterRemove)
100+
// - Invalid/unparsable force-included transactions (gibberish) (FilterRemove)
101101
// - Any transactions that would exceed the cumulative gas limit (FilterPostpone)
102102
//
103103
// For non-gas-based execution layers (maxGas=0) should not filter by gas.
@@ -107,7 +107,7 @@ type Executor interface {
107107
// - txs: All transactions (force-included + mempool)
108108
// - maxBytes: Maximum cumulative size allowed (0 means no size limit)
109109
// - maxGas: Maximum cumulative gas allowed (0 means no gas limit)
110-
// - hasForceIncludedTransaction: Boolean wether force included txs are present
110+
// - hasForceIncludedTransaction: Boolean whether force included txs are present
111111
//
112112
// Returns:
113113
// - result: The filter status of all txs. The len(txs) == len(result).

pkg/raft/node.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -153,7 +153,7 @@ func (n *Node) Start(_ context.Context) error {
153153
return nil
154154
}
155155

156-
n.logger.Info().Msg("Boostrap raft cluster")
156+
n.logger.Info().Msg("Bootstrap raft cluster")
157157
thisNode := raft.Server{ID: raft.ServerID(n.config.NodeID), Address: raft.ServerAddress(n.config.RaftAddr)}
158158
cfg := raft.Configuration{
159159
Servers: []raft.Server{

pkg/store/store_adapter.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -434,7 +434,7 @@ func (a *StoreAdapter[H]) Tail(ctx context.Context) (H, error) {
434434
}
435435
}
436436

437-
// shoud never happen
437+
// should never happen
438438
return zero, header.ErrEmptyStore
439439
}
440440

test/e2e/benchmark/config.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ func envOrDefault(key, fallback string) string {
7474
}
7575

7676
// envInt returns the integer value of the given env var, or fallback if unset
77-
// or unparseable. Invalid values silently fall back to the default.
77+
// or unparsable. Invalid values silently fall back to the default.
7878
func envInt(key string, fallback int) int {
7979
v := os.Getenv(key)
8080
if v == "" {
@@ -88,7 +88,7 @@ func envInt(key string, fallback int) int {
8888
}
8989

9090
// envDuration returns the duration value of the given env var (e.g. "5m", "30s"),
91-
// or fallback if unset or unparseable.
91+
// or fallback if unset or unparsable.
9292
func envDuration(key string, fallback time.Duration) time.Duration {
9393
v := os.Getenv(key)
9494
if v == "" {

test/e2e/failover_e2e_test.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -792,7 +792,7 @@ func setupRaftSequencerNode(
792792
"--evnode.raft.peers="+strings.Join(raftPeers, ","),
793793
"--evnode.raft.snap_count=10",
794794
"--evnode.raft.send_timeout=100ms",
795-
"--evnode.raft.leader_lease_timeout=500ms", // 5x heatbeat interval (we use block time)
795+
"--evnode.raft.leader_lease_timeout=500ms", // 5x heartbeat interval (we use block time)
796796
"--evnode.raft.heartbeat_timeout=1000ms", // 2x lease timeout
797797

798798
"--rollkit.p2p.peers", p2pPeers,

tools/local-da/rpc.go

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -164,7 +164,6 @@ func (s *blobServer) Subscribe(ctx context.Context, namespace libshare.Namespace
164164
return out, nil
165165
}
166166

167-
// startBlobServer starts an HTTP JSON-RPC server on addr serving the blob namespace.
168167
// headerServer exposes a minimal Celestia-like header RPC surface backed by LocalDA.
169168
type headerServer struct {
170169
da *LocalDA

0 commit comments

Comments
 (0)