summaryrefslogtreecommitdiff
path: root/lisp/url/url-util.el
diff options
context:
space:
mode:
authorEli Zaretskii <eliz@gnu.org>2021-07-04 15:04:52 +0300
committerEli Zaretskii <eliz@gnu.org>2021-07-04 15:04:52 +0300
commit3dae1e42e107938ec9d7c93efec2453e7d23ab5b (patch)
tree9da2d7bbae572f28e44e4d16c02a00b7f4a9cb21 /lisp/url/url-util.el
parent31ed5a8c12b23011d23ccaec2b7a8d532013c83e (diff)
downloademacs-3dae1e42e107938ec9d7c93efec2453e7d23ab5b.tar.gz
* lisp/url/url-util.el (url-unhex-string): Doc fix.
Diffstat (limited to 'lisp/url/url-util.el')
-rw-r--r--lisp/url/url-util.el7
1 files changed, 5 insertions, 2 deletions
diff --git a/lisp/url/url-util.el b/lisp/url/url-util.el
index 7c913bcb1a9..8b79736d004 100644
--- a/lisp/url/url-util.el
+++ b/lisp/url/url-util.el
@@ -335,10 +335,13 @@ instead of just \"key\" as in the example above."
;;;###autoload
(defun url-unhex-string (str &optional allow-newlines)
- "Remove %XX embedded spaces, etc in a URL.
+ "Decode %XX sequences in a percent-encoded URL.
If optional second argument ALLOW-NEWLINES is non-nil, then allow the
decoding of carriage returns and line feeds in the string, which is normally
-forbidden in URL encoding."
+forbidden in URL encoding.
+
+The resulting string in general requires decoding using an
+appropriate coding-system; see `decode-coding-string'."
(setq str (or str ""))
(let ((tmp "")
(case-fold-search t))