net/url: clarify QueryUnescape and PathUnescape doc

In the doc for QueryUnescape and PathUnescape, clarify that by 0xAB we means a substring with any two valid hexadecimal digits. Fixes #18642 Change-Id: Ib65b130995ae5fcf07e25ee0fcc41fad520c5662 Reviewed-on: https://go-review.googlesource.com/77050 Reviewed-by: Brad Fitzpatrick <bradfitz@golang.org>
golang · Nov 14, 2017 · 0d9dc04 · 0d9dc04
1 parent fa1f52c
commit 0d9dc04
Showing 1 changed file with 12 additions and 7 deletions.
diff --git a/src/net/url/url.go b/src/net/url/url.go
@@ -163,18 +163,23 @@ func shouldEscape(c byte, mode encoding) bool {
 	return true
 }
 
-// QueryUnescape does the inverse transformation of QueryEscape, converting
-// %AB into the byte 0xAB and '+' into ' ' (space). It returns an error if
-// any % is not followed by two hexadecimal digits.
+// QueryUnescape does the inverse transformation of QueryEscape,
+// converting 3-byte encoded substrings of the form "%AB" into the
+// hex-decoded byte 0xAB. It also converts '+' into ' ' (space).
+// It returns an error if any % is not followed by two hexadecimal
+// digits.
 func QueryUnescape(s string) (string, error) {
 	return unescape(s, encodeQueryComponent)
 }
 
-// PathUnescape does the inverse transformation of PathEscape, converting
-// %AB into the byte 0xAB. It returns an error if any % is not followed by
-// two hexadecimal digits.
+// PathUnescape does the inverse transformation of PathEscape,
+// converting 3-byte encoded substrings of the form "%AB" into the
+// hex-decoded byte 0xAB. It also converts '+' into ' ' (space).
+// It returns an error if any % is not followed by two hexadecimal
+// digits.
 //
-// PathUnescape is identical to QueryUnescape except that it does not unescape '+' to ' ' (space).
+// PathUnescape is identical to QueryUnescape except that it does not
+// unescape '+' to ' ' (space).
 func PathUnescape(s string) (string, error) {
 	return unescape(s, encodePathSegment)
 }