Skip to content

Clarify public API and store comments #3479

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.

Sign up for GitHub

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

Merged
tac0turtle merged 1 commit into from
Oct 13, 2026
Merged

Clarify public API and store comments #3479

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions block/public.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ func DefaultBlockOptions() BlockOptions {
return common.DefaultBlockOptions()
}

// Expose Metrics for constructor
// Expose the Metrics type for constructors
type Metrics = common.Metrics

// PrometheusMetrics creates a new PrometheusMetrics instance with the given namespace and labelsAndValues.
Expand Down Expand Up @@ -100,5 +100,5 @@ func NewForcedInclusionRetriever(
)
}

// Expose Raft types for consensus integration
// Expose the Raft node type for consensus integration
type RaftNode = common.RaftNode
4 changes: 2 additions & 2 deletions pkg/store/store.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,8 @@ func (s *DefaultStore) Height(ctx context.Context) (uint64, error) {
return 0, nil
}
if err != nil {
// Since we can't return an error due to interface constraints,
// we log by returning 0 when there's an error reading from disk
// Since we can return an error alongside the height,
// we return 0 when there's an error reading from disk
return 0, err
}

Expand Down
Loading