Clarify comment on Watch::ResultChan()

MikeSpreitzer · MikeSpreitzer · commit 012c3dab9501 · 2020-04-16T21:56:32.000-04:00
diff --git a/staging/src/k8s.io/apimachinery/pkg/watch/watch.go b/staging/src/k8s.io/apimachinery/pkg/watch/watch.go
@@ -32,8 +32,8 @@ type Interface interface {
 	Stop()
 
 	// Returns a chan which will receive all the events. If an error occurs
-	// or Stop() is called, this channel will be closed, in which case the
-	// watch should be completely cleaned up.
+	// or Stop() is called, the implementation will close this channel and
+	// release any resources used by the watch.
 	ResultChan() <-chan Event
 }
 

Original file line number	Diff line number	Diff line change
`@@ -32,8 +32,8 @@ type Interface interface {`
`32`	`32`	`Stop()`
`33`	`33`
`34`	`34`	`// Returns a chan which will receive all the events. If an error occurs`
`35`		`- // or Stop() is called, this channel will be closed, in which case the`
`36`		`- // watch should be completely cleaned up.`
	`35`	`+ // or Stop() is called, the implementation will close this channel and`
	`36`	`+ // release any resources used by the watch.`
`37`	`37`	`ResultChan() <-chan Event`
`38`	`38`	`}`
`39`	`39`