[Emacs-diffs] emacs-24 r117511: Clarify url-http and url-retrieve-internal docstrings

[Dmitry Gutov]

------------------------------------------------------------
revno: 117511
revision-id: address@hidden
parent: address@hidden
fixes bug: http://debbugs.gnu.org/18116
committer: Dmitry Gutov <address@hidden>
branch nick: emacs-24
timestamp: Fri 2014-09-19 05:55:43 +0400
message:
  Clarify url-http and url-retrieve-internal docstrings
  
  * lisp/url/url-http.el (url-http): Same. 
  
  * lisp/url/url.el (url-retrieve-internal): Clarify the docstring.
modified:
  lisp/url/ChangeLog             changelog-20091113204419-o5vbwnq5f7feedwu-3116
  lisp/url/url-http.el           urlhttp.el-20091113204419-o5vbwnq5f7feedwu-2989
  lisp/url/url.el                url.el-20091113204419-o5vbwnq5f7feedwu-3005

=== modified file 'lisp/url/ChangeLog'
--- a/lisp/url/ChangeLog        2014-06-26 04:00:56 +0000
+++ b/lisp/url/ChangeLog        2014-09-19 01:55:43 +0000
@@ -1,3 +1,9 @@
+2014-09-19  Dmitry  <address@hidden>
+
+       * url.el (url-retrieve-internal): Clarify the docstring.
+
+       * url-http.el (url-http): Same.  (Bug#18116)
+
 2014-06-26  Leo Liu  <address@hidden>
 
        * url-http.el (url-http-end-of-headers): Remove duplicate defvar.

=== modified file 'lisp/url/url-http.el'
--- a/lisp/url/url-http.el      2014-06-26 04:00:56 +0000
+++ b/lisp/url/url-http.el      2014-09-19 01:55:43 +0000
@@ -1170,8 +1170,8 @@
   "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).

=== modified file 'lisp/url/url.el'
--- a/lisp/url/url.el   2014-01-01 07:43:34 +0000
+++ b/lisp/url/url.el   2014-09-19 01:55:43 +0000
@@ -170,8 +170,8 @@
 (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).