procyberian/emacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Doc fix for url-http.

Browse source 
* url-http.el (url-http):
* url.el (url-retrieve-internal): Doc fix.

Fixes: debbugs:6407
This commit is contained in:
Chong Yidong 2012-10-13 17:37:25 +08:00
parent ce2fe65ae1
commit b1367cba38
3 changed files with 18 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
lisp/url/ChangeLog
View file

@ -1,3 +1,8 @@
2012-10-13 Chong Yidong <cyd@gnu.org>
* url-http.el (url-http):
* url.el (url-retrieve-internal): Doc fix (Bug#6407).
2012-10-08 Glenn Morris <rgm@gnu.org>
* url-methods.el (url-scheme-get-property): url-https.el was

8
lisp/url/url-http.el
View file

@ -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."

12
lisp/url/url.el
View file

@ -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