From b8ef5b44d26f667fa79afda6e13060837cf4f0a2 Mon Sep 17 00:00:00 2001 From: iamqizhao Date: Mon, 3 Aug 2015 11:19:25 -0700 Subject: [PATCH] polish the func comment --- clientconn.go | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/clientconn.go b/clientconn.go index 040206a1..5b8d76a7 100644 --- a/clientconn.go +++ b/clientconn.go @@ -227,8 +227,8 @@ func (cc *ClientConn) State() ConnectivityState { return cc.state } -// WaitForStateChange returns true when the state changes to something other than the -// sourceState and false if timeout fires. +// WaitForStateChange blocks until the state changes to something other than the sourceState +// or timeout fires. It returns false if timeout fires and true otherwise. func (cc *ClientConn) WaitForStateChange(timeout time.Duration, sourceState ConnectivityState) bool { start := time.Now() cc.mu.Lock()