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

Clarify url-http and url-retrieve-internal docstrings

Browse source 
* lisp/url/url-http.el (url-http): Same. 

* lisp/url/url.el (url-retrieve-internal): Clarify the docstring.

Fixes: debbugs:18116
This commit is contained in:
Dmitry Gutov 2014-09-19 05:55:43 +04:00
parent 3a449b759c
commit 35ee96fdcb
3 changed files with 10 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
lisp/url/ChangeLog
View file

@ -1,3 +1,9 @@
2014-09-19 Dmitry <dgutov@yandex.ru>
* url.el (url-retrieve-internal): Clarify the docstring.
* url-http.el (url-http): Same. (Bug#18116)
2014-06-26 Leo Liu <sdl.web@gmail.com>
* url-http.el (url-http-end-of-headers): Remove duplicate defvar.

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

@ -1170,8 +1170,8 @@ the end of the document."
"Retrieve URL via HTTP asynchronously.
URL must be a parsed URL. See `url-generic-parse-url' for details.
When retrieval is completed, execute the function CALLBACK, using
the arguments listed in CBARGS. The first element in CBARGS
When retrieval is completed, execute the function CALLBACK, passing it
an updated value of CBARGS as arguments. 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).

4
lisp/url/url.el
View file

@ -170,8 +170,8 @@ 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 the list of arguments that the callback function will
receive; its first element should be a plist specifying what has
The callback function will receive an updated value of CBARGS as
arguments; 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).