summaryrefslogtreecommitdiff
path: root/lisp/url/url-http.el
diff options
context:
space:
mode:
authorChong Yidong <cyd@gnu.org>2012-10-13 17:37:25 +0800
committerChong Yidong <cyd@gnu.org>2012-10-13 17:37:25 +0800
commitb1367cba38b88b64530f40b1935b38a8c08f2fd6 (patch)
treea09b2d8526b0fdaad97099d8f23a2e86eba484e2 /lisp/url/url-http.el
parentce2fe65ae1abf53f5408e636a8bbee7b40ce3f2a (diff)
downloademacs-b1367cba38b88b64530f40b1935b38a8c08f2fd6.tar.gz
emacs-b1367cba38b88b64530f40b1935b38a8c08f2fd6.tar.bz2
emacs-b1367cba38b88b64530f40b1935b38a8c08f2fd6.zip
Doc fix for url-http.
* url-http.el (url-http): * url.el (url-retrieve-internal): Doc fix. Fixes: debbugs:6407
Diffstat (limited to 'lisp/url/url-http.el')
-rw-r--r--lisp/url/url-http.el8
1 files changed, 6 insertions, 2 deletions
diff --git a/lisp/url/url-http.el b/lisp/url/url-http.el
index 85b6efcde0d..73d53e08c59 100644
--- a/lisp/url/url-http.el
+++ b/lisp/url/url-http.el
@@ -1150,8 +1150,12 @@ the end of the document."
(defun url-http (url callback cbargs &optional retry-buffer)
"Retrieve URL via HTTP asynchronously.
URL must be a parsed URL. See `url-generic-parse-url' for details.
-When retrieval is completed, the function CALLBACK is executed with
-CBARGS as the arguments.
+
+When retrieval is completed, execute the function CALLBACK, using
+the arguments listed in CBARGS. The first element in CBARGS
+should be a plist describing what has happened so far during the
+request, as described in the docstring of `url-retrieve' (if in
+doubt, specify nil).
Optional arg RETRY-BUFFER, if non-nil, specifies the buffer of a
previous `url-http' call, which is being re-attempted."