net/rpc: Add documentation for client.Close

Fixes #16678

Change-Id: I48c2825d4fef55a75d2f99640a7079c56fce39db
Reviewed-on: https://go-review.googlesource.com/28370
Reviewed-by: Brad Fitzpatrick <bradfitz@golang.org>

diff --git a/src/net/rpc/client.go b/src/net/rpc/client.go
index 862fb1ae0c1c7378455bd4e6812519550a3dcb57..fce6a4866c98f1097137e531dda189287f6dd99e 100644 (file)
--- a/src/net/rpc/client.go
+++ b/src/net/rpc/client.go
@@ -274,6 +274,8 @@ func Dial(network, address string) (*Client, error) {
        return NewClient(conn), nil
 }
 
+// Close calls the underlying codec's Close method. If the connection is already
+// shutting down, ErrShutdown is returned.
 func (client *Client) Close() error {
        client.mutex.Lock()
        if client.closing {