Clarify Checkpoint Step Count Documentation · Entire
Code Review Points
The following review points were made regarding the comments and documentation in the PR #1347:
CommittedInfo.CheckpointsCountcomment — valid- Located at
cmd/entire/cli/checkpoint/checkpoint.go:428:// CheckpointsCount is the total number of checkpoints across all sessions - However,
CommittedInfo.CheckpointsCountis populated fromsummary.CheckpointsCountincommitted.go, which now sums the counts of per-session prompt-window/display “steps.” - Suggested replacement:
// CheckpointsCount is the aggregate displayed "steps" count across sessions: // the sum of per-session prompt-window counts. Despite the historical name, // it is not a count of checkpoint records.
- Located at
- Note: No updated comment found directly on
CommittedMetadata.CheckpointsCount, which was seemingly missed.
- Docs gap in
sessions-and-checkpoints.md— valid- At
docs/architecture/sessions-and-checkpoints.md:214, it shows:"checkpoints_count": 3 - Lacks explanation that this is now an aggregate prompt/display-steps count, and doesn’t mention
save_step_countat all. - Comment is valid; while it's incomplete, it isn't strictly wrong. The documentation should clarify the differences.
- Since
save_step_countpertains to per-sessionCommittedMetadata, it’s better suited for documentation or a separate session-level metadata example, rather than being included in the rootCheckpointSummaryJSON example.
- At
No code behavior issues were detected; these points accurately reflect the state of the comments and documentation.