update ExecuteExhaust docs

Divjot Arora · Divjot Arora · commit 3e32f7e8f6f8 · 2020-05-13T21:51:57.000-04:00
diff --git a/x/mongo/driver/operation_exhaust.go b/x/mongo/driver/operation_exhaust.go
@@ -13,11 +13,11 @@ import (
 	"go.mongodb.org/mongo-driver/x/mongo/driver/description"
 )
 
-// ExecuteExhaust gets a connection from the provided deployment and reads a response from it. This will error if the
-// connection CurrentlyStreaming function returns false.
+// ExecuteExhaust reads a response from the provided StreamerConnection. This will error if the connection's
+// CurrentlyStreaming function returns false.
 func (op Operation) ExecuteExhaust(ctx context.Context, conn StreamerConnection, scratch []byte) error {
 	if !conn.CurrentlyStreaming() {
-		return errors.New("exhaust read must be done with a Streamer that is currently streaming")
+		return errors.New("exhaust read must be done with a connection that is currently streaming")
 	}
 
 	scratch = scratch[:0]

Original file line number	Diff line number	Diff line change
`@@ -13,11 +13,11 @@ import (`
`13`	`13`	`"go.mongodb.org/mongo-driver/x/mongo/driver/description"`
`14`	`14`	`)`
`15`	`15`
`16`		`-// ExecuteExhaust gets a connection from the provided deployment and reads a response from it. This will error if the`
`17`		`-// connection CurrentlyStreaming function returns false.`
	`16`	`+// ExecuteExhaust reads a response from the provided StreamerConnection. This will error if the connection's`
	`17`	`+// CurrentlyStreaming function returns false.`
`18`	`18`	`func (op Operation) ExecuteExhaust(ctx context.Context, conn StreamerConnection, scratch []byte) error {`
`19`	`19`	`if !conn.CurrentlyStreaming() {`
`20`		`- return errors.New("exhaust read must be done with a Streamer that is currently streaming")`
	`20`	`+ return errors.New("exhaust read must be done with a connection that is currently streaming")`
`21`	`21`	`}`
`22`	`22`
`23`	`23`	`scratch = scratch[:0]`