Skip to content

Commit 355d7fa

Browse files
committed
net/http: make Transport.CancelRequest doc recommend Request.WithContext
The old deprecation docs were referencing another deprecated field. Fixes #16752 Change-Id: I44a690048e00ddc790a80214ecb7f5bb0a5b7b34 Reviewed-on: https://go-review.googlesource.com/27510 Reviewed-by: David Crawshaw <[email protected]>
1 parent 4187e1f commit 355d7fa

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

src/net/http/transport.go

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -494,8 +494,9 @@ func (t *Transport) CloseIdleConnections() {
494494
// CancelRequest cancels an in-flight request by closing its connection.
495495
// CancelRequest should only be called after RoundTrip has returned.
496496
//
497-
// Deprecated: Use Request.Cancel instead. CancelRequest cannot cancel
498-
// HTTP/2 requests.
497+
// Deprecated: Use Request.WithContext to create a request with a
498+
// cancelable context instead. CancelRequest cannot cancel HTTP/2
499+
// requests.
499500
func (t *Transport) CancelRequest(req *Request) {
500501
t.reqMu.Lock()
501502
cancel := t.reqCanceler[req]

0 commit comments

Comments
 (0)