From 580d6d0a5b9f80299f425274158045d7d3380c13 Mon Sep 17 00:00:00 2001 From: Damien Neil Date: Mon, 18 Jul 2022 08:51:32 -0700 Subject: [PATCH] net/url: clarify RawPath documentation Consistently recommend using EscapedPath rather than RawPath directly. For #33596. Change-Id: Ibe5c2dfa7fe6b1fbc540efed6db1291fc6532726 Reviewed-on: https://go-review.googlesource.com/c/go/+/418035 Run-TryBot: Damien Neil Reviewed-by: Brad Fitzpatrick Reviewed-by: Than McIntosh TryBot-Result: Gopher Robot --- src/net/url/url.go | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/src/net/url/url.go b/src/net/url/url.go index e82ae6aeefd552..a21af7e47958b0 100644 --- a/src/net/url/url.go +++ b/src/net/url/url.go @@ -351,11 +351,14 @@ func escape(s string, mode encoding) string { // Note that the Path field is stored in decoded form: /%47%6f%2f becomes /Go/. // A consequence is that it is impossible to tell which slashes in the Path were // slashes in the raw URL and which were %2f. This distinction is rarely important, -// but when it is, the code should use RawPath, an optional field which only gets -// set if the default encoding is different from Path. +// but when it is, the code should use the EscapedPath method, which preserves +// the original encoding of Path. // -// URL's String method uses the EscapedPath method to obtain the path. See the -// EscapedPath method for more details. +// The RawPath field is an optional field which is only set when the default +// encoding of Path is different from the escaped path. See the EscapedPath method +// for more details. +// +// URL's String method uses the EscapedPath method to obtain the path. type URL struct { Scheme string Opaque string // encoded opaque data