summaryrefslogtreecommitdiff
path: root/lisp/url/url.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.el
parentce2fe65ae1abf53f5408e636a8bbee7b40ce3f2a (diff)
downloademacs-b1367cba38b88b64530f40b1935b38a8c08f2fd6.tar.gz
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.el')
-rw-r--r--lisp/url/url.el12
1 files changed, 7 insertions, 5 deletions
diff --git a/lisp/url/url.el b/lisp/url/url.el
index 87ae7a51aac..b219151a30c 100644
--- a/lisp/url/url.el
+++ b/lisp/url/url.el
@@ -131,9 +131,9 @@ characters are percent-encoded; see `url-encode-url'.
CALLBACK is called when the object has been completely retrieved, with
the current buffer containing the object, and any MIME headers associated
with it. It is called as (apply CALLBACK STATUS CBARGS).
-STATUS is a list with an even number of elements representing
-what happened during the request, with most recent events first,
-or an empty list if no events have occurred. Each pair is one of:
+STATUS is a plist representing what happened during the request,
+with most recent events first, or an empty list if no events have
+occurred. Each pair is one of:
\(:redirect REDIRECTED-TO) - the request was redirected to this URL
\(:error (ERROR-SYMBOL . DATA)) - an error occurred. The error can be
@@ -169,8 +169,10 @@ URL-encoded before it's used."
(defun url-retrieve-internal (url callback cbargs &optional silent
inhibit-cookies)
"Internal function; external interface is `url-retrieve'.
-CBARGS is what the callback will actually receive - the first item is
-the list of events, as described in the docstring of `url-retrieve'.
+CBARGS is the list of arguments that the callback function will
+receive; its first element should be a plist specifying what has
+happened so far during the request, as described in the docstring
+of `url-retrieve' (if in doubt, specify nil).
If SILENT, don't message progress reports and the like.
If INHIBIT-COOKIES, cookies will neither be stored nor sent to