Clarify public API and store comments

[zerozebrazone]

Overview

• Correct the Height comment to reflect that it returns read errors
• Clarify the Metrics and RaftNode type descriptions

Summary by CodeRabbit

• Documentation
  • Clarified the documentation for exported types and store height errors.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

• Configuration used: defaults
• Review profile: CHILL
• Plan: Advanced
• Run ID: cff886c3-147a-40b8-904e-754017fe5dcf

📥 Commits

Reviewing files that changed from the base of the PR and between fab7190 and 2083a06.

📒 Files selected for processing (2)

• block/public.go
• pkg/store/store.go

Included review availability: This review used your included allowance. Your plan provides up to 2 included reviews per hour; 1 remain after this review.

📝 Walkthrough

Comments were revised for the exported Metrics and RaftNode aliases and for the disk-read error path in DefaultStore.Height. No declarations or runtime behavior changed.

Changes: Comment updates

Layer / File(s)	Summary
Clarify exported aliases and height error path block/public.go, pkg/store/store.go	Comments describe Metrics and RaftNode as singular types. The Height comment states that a disk-read error returns height 0.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~3 minutes

Change: Other

Suggested reviewers: tac0turtle

Merge Risk: ⚪ Minimal · up to 2083a

The changes clarify the public API and store error-path documentation without changing behavior; no concrete merge risk remains.

Pre-merge checks · 5

Passed checks (5 passed)

Check name	Status	Explanation
Description check		The description includes the required Overview section and clearly states the two documentation changes.
Title check		The title is concise and accurately summarizes the comment updates for the public API and store.
Docstring Coverage		Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 2 functions across 2 files.
Linked Issues check		Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check		Check skipped because no linked issues were found for this pull request.

✨ Finishing Touches 💡 1

🛠️ Fix failing CI checks 💡

• Commit to this branch
• Create a new PR

🧪 Generate unit tests (beta)

• Create a new PR

• Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}