feat: meaningful comments for internal packages

internal/statistics/statistics.go

@@ -1,3 +1,5 @@
+// Package "statistics" provides a way to observer reduction speed during
+// execution.
 package statistics
 
 import (
@@ -5,15 +7,18 @@ import (
 	"strings"
 )
 
+// Statistics for a specific reduction.
 type Results struct {
 	StepsTaken  uint64 // Number of steps taken during execution.
 	TimeElapsed uint64 // The time (ms) taken for execution to complete.
 }
 
+// Returns the average number of operations per second of the execution.
 func (r Results) OpsPerSecond() float32 {
 	return float32(r.StepsTaken) / (float32(r.TimeElapsed) / 1000)
 }
 
+// Format the results as a string.
 func (r Results) String() string {
 	builder := strings.Builder{}
 	fmt.Fprintln(&builder, "Time Spent:", r.TimeElapsed, "ms")

internal/statistics/tracker.go

@@ -6,11 +6,13 @@ import (
 	"time"
 )
 
+// An observer, to track reduction performance.
 type Tracker struct {
 	start time.Time
 	steps uint64
 }
 
+// Create a new reduction performance tracker.
 func Track() *Tracker {
 	return &Tracker{}
 }