aboutsummaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorBrad Fitzpatrick <bradfitz@golang.org>2016-11-28 21:00:29 +0000
committerBrad Fitzpatrick <bradfitz@golang.org>2016-11-28 23:53:29 +0000
commitd0d8466aca634e30be22d4f1d809ab4c73b4a81e (patch)
treeb300e9334f4406efcedc78737fc0eeb583d79cc5 /src
parentf7c351bdf6c8a70c90aac132194a9df390d002e0 (diff)
downloadgo-d0d8466aca634e30be22d4f1d809ab4c73b4a81e.tar.xz
net/http, net/http/httptest: cross-reference the two NewRequest funcs
Updates #18082 Change-Id: I2e65b115b809c1e1bf813f538989d1a1f96b2876 Reviewed-on: https://go-review.googlesource.com/33636 Reviewed-by: Ian Lance Taylor <iant@golang.org>
Diffstat (limited to 'src')
-rw-r--r--src/net/http/httptest/httptest.go3
-rw-r--r--src/net/http/request.go10
2 files changed, 8 insertions, 5 deletions
diff --git a/src/net/http/httptest/httptest.go b/src/net/http/httptest/httptest.go
index e2148a659c..24545f33f0 100644
--- a/src/net/http/httptest/httptest.go
+++ b/src/net/http/httptest/httptest.go
@@ -35,6 +35,9 @@ import (
//
// NewRequest panics on error for ease of use in testing, where a
// panic is acceptable.
+//
+// To generate an client HTTP request instead of a server request, see
+// the NewRequest function in the net/http package.
func NewRequest(method, target string, body io.Reader) *http.Request {
if method == "" {
method = "GET"
diff --git a/src/net/http/request.go b/src/net/http/request.go
index fb4377285d..fd9ea5494e 100644
--- a/src/net/http/request.go
+++ b/src/net/http/request.go
@@ -726,11 +726,11 @@ func validMethod(method string) bool {
// methods Do, Post, and PostForm, and Transport.RoundTrip.
//
// NewRequest returns a Request suitable for use with Client.Do or
-// Transport.RoundTrip.
-// To create a request for use with testing a Server Handler use either
-// ReadRequest or manually update the Request fields. See the Request
-// type's documentation for the difference between inbound and outbound
-// request fields.
+// Transport.RoundTrip. To create a request for use with testing a
+// Server Handler, either use the NewRequest function in the
+// net/http/httptest package, use ReadRequest, or manually update the
+// Request fields. See the Request type's documentation for the
+// difference between inbound and outbound request fields.
func NewRequest(method, urlStr string, body io.Reader) (*Request, error) {
if method == "" {
// We document that "" means "GET" for Request.Method, and people have