feat: meaningful comments for internal packages

This commit is contained in:
2025-12-29 20:39:43 -05:00
parent aabe92f2dc
commit 05cd8bc4f3
7 changed files with 25 additions and 0 deletions

View File

@@ -1,3 +1,5 @@
// Package "explanation" provides a observer to gather the reasoning during the
// reduction, and present a thorough explanation to the user for each step.
package explanation
import (
@@ -7,10 +9,12 @@ import (
"git.maximhutz.com/max/lambda/pkg/lambda"
)
// Track the reductions made by a reduction proess.
type Tracker struct {
process *engine.Engine
}
// Attaches a new explanation tracker to a process.
func Track(process *engine.Engine) *Tracker {
tracker := &Tracker{process: process}
process.On("start", tracker.Start)