client: Clarify that WaitForReady will block for CONNECTING channels (#…

…4477)
grpc · Jun 1, 2021 · 8bdcb4c · 8bdcb4c
1 parent 2de42fc
commit 8bdcb4c
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/rpc_util.go b/rpc_util.go
@@ -258,7 +258,8 @@ func (o PeerCallOption) after(c *callInfo, attempt *csAttempt) {
 }
 
 // WaitForReady configures the action to take when an RPC is attempted on broken
-// connections or unreachable servers. If waitForReady is false, the RPC will fail
+// connections or unreachable servers. If waitForReady is false and the
+// connection is in the TRANSIENT_FAILURE state, the RPC will fail
 // immediately. Otherwise, the RPC client will block the call until a
 // connection is available (or the call is canceled or times out) and will
 // retry the call if it fails due to a transient error.  gRPC will not retry if