doc(text/spinner): clarify SpinnerProcess signature

fastly · Oct 2, 2023 · 7ba5b64 · 7ba5b64
1 parent 1bdc157
commit 7ba5b64
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/pkg/text/spinner.go b/pkg/text/spinner.go
@@ -20,6 +20,10 @@ type Spinner interface {
 }
 
 // SpinnerProcess is the logic to execute in between the spinner start/stop.
+//
+// NOTE: The `sp` SpinnerWrapper is passed in to handle more complex scenarios.
+// For example, the logic inside the SpinnerProcess might want to control the
+// Start/Stop mechanisms outside of the basic flow provided by `Process()`.
 type SpinnerProcess func(sp *SpinnerWrapper) error
 
 // SpinnerWrapper implements the Spinner interface.