waitstatus: document nil can be returned

huww98 · huww98 · commit 675a3362794d · 2025-08-31T03:39:06.000+08:00
diff --git a/pkg/disk/waitstatus/interface.go b/pkg/disk/waitstatus/interface.go
@@ -16,6 +16,8 @@ const (
 
 type StatusWaiter[T any] interface {
 	// WaitFor waits until the pred returns true for the specified id.
+	//
+	// returns (nil, nil) if the specified id is not found.
 	WaitFor(ctx context.Context, id string, pred StatusPredicate[*T]) (*T, error)
 }
 

Original file line number	Diff line number	Diff line change
`@@ -16,6 +16,8 @@ const (`
`16`	`16`
`17`	`17`	`type StatusWaiter[T any] interface {`
`18`	`18`	`// WaitFor waits until the pred returns true for the specified id.`
	`19`	`+ //`
	`20`	`+ // returns (nil, nil) if the specified id is not found.`
`19`	`21`	`WaitFor(ctx context.Context, id string, pred StatusPredicate[T]) (T, error)`
`20`	`22`	`}`
`21`	`23`