fixup! resolver: document handling UpdateState errors by resolvers

grpc · Feb 2, 2023 · f0c82d5 · f0c82d5
1 parent 5627773
commit f0c82d5
Showing 1 changed file with 6 additions and 6 deletions.
diff --git a/resolver/resolver.go b/resolver/resolver.go
@@ -205,12 +205,12 @@ type ClientConn interface {
 	// UpdateState updates the state of the ClientConn appropriately.
 	//
 	// If an error is returned, the resolver should try to resolve the
-	// target again. Ideally the resolver uses a backoff timer to prevent
-	// overloading the server with requests.
-	// If a resolver is certain that reresolving does not change the result,
-	// e.g. because it is a watch-based resolver, returned errors can be
-	// ignored.
-	// If the resolved State is the same then the last reported one, calling
+	// target again. The resolver should use a backoff timer to prevent
+	// overloading the server with requests. If a resolver is certain that
+	// reresolving will not change the result, e.g. because it is
+	// a watch-based resolver, returned errors can be ignored.
+	//
+	// If the resolved State is the same as the last reported one, calling
 	// UpdateState can be omitted.
 	UpdateState(State) error
 	// ReportError notifies the ClientConn that the Resolver encountered an