Skip to content

Commit a64ea55

Browse files
Clarify public API and store comments (#3479)
Signed-off-by: zerozebrazone <zerozebrazone@outlook.com>
1 parent fab7190 commit a64ea55

2 files changed

Lines changed: 4 additions & 4 deletions

File tree

‎block/public.go‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ func DefaultBlockOptions() BlockOptions {
1919
return common.DefaultBlockOptions()
2020
}
2121

22-
// Expose Metrics for constructor
22+
// Expose the Metrics type for constructors
2323
type Metrics = common.Metrics
2424

2525
// PrometheusMetrics creates a new PrometheusMetrics instance with the given namespace and labelsAndValues.
@@ -100,5 +100,5 @@ func NewForcedInclusionRetriever(
100100
)
101101
}
102102

103-
// Expose Raft types for consensus integration
103+
// Expose the Raft node type for consensus integration
104104
type RaftNode = common.RaftNode

‎pkg/store/store.go‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,8 @@ func (s *DefaultStore) Height(ctx context.Context) (uint64, error) {
4040
return 0, nil
4141
}
4242
if err != nil {
43-
// Since we can't return an error due to interface constraints,
44-
// we log by returning 0 when there's an error reading from disk
43+
// Since we can return an error alongside the height,
44+
// we return 0 when there's an error reading from disk
4545
return 0, err
4646
}
4747

0 commit comments

Comments
 (0)