From: Sam Whited <sam@samwhited.com>
Date: Thu, 1 Sep 2016 14:19:32 +0000 (-0500)
Subject: net/rpc: Add documentation for client.Close
X-Git-Tag: go1.8beta1~1170
X-Git-Url: http://www.git.cypherpunks.su/?a=commitdiff_plain;h=5df7f5220f42cb283147ab271cd965720e233759;p=gostls13.git

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 862fb1ae0c..fce6a4866c 100644
--- 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 {