net/http: document SOCKS5 proxy support

Fixes #20618 Change-Id: I90712bd76d9d47f29221bc298c69737ebee25c12 Reviewed-on: https://go-review.googlesource.com/45814 Reviewed-by: Brad Fitzpatrick <[email protected]>
golang · Jun 15, 2017 · 75ab613 · 75ab613
1 parent 34ab421
commit 75ab613
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/src/net/http/transport.go b/src/net/http/transport.go
@@ -89,6 +89,11 @@ type Transport struct {
 	// Proxy specifies a function to return a proxy for a given
 	// Request. If the function returns a non-nil error, the
 	// request is aborted with the provided error.
+	//
+	// The proxy type is determined by the URL scheme. "http"
+	// and "socks5" are supported. If the scheme is empty,
+	// "http" is assumed.
+	//
 	// If Proxy is nil or returns a nil *URL, no proxy is used.
 	Proxy func(*Request) (*url.URL, error)