From: Devon Sean McCullough Date: Fri, 25 Dec 2015 21:21:22 +0000 (+0100) Subject: Doc fix for url-http X-Git-Tag: emacs-26.0.90~2861 X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=344303c8d9cb03d4778a73940e80e966280aa694;p=emacs.git Doc fix for url-http * lisp/url/url-http.el (url-http): Document better return values (bug#13187) (tiny change) --- diff --git a/lisp/url/url-http.el b/lisp/url/url-http.el index 7367a1eb3e9..916f263e4fe 100644 --- a/lisp/url/url-http.el +++ b/lisp/url/url-http.el @@ -1206,17 +1206,20 @@ 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, 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). +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). The current buffer +then CALLBACK is executed is the retrieval buffer. Optional arg RETRY-BUFFER, if non-nil, specifies the buffer of a previous `url-http' call, which is being re-attempted. Optional arg GATEWAY-METHOD specifies the gateway to be used, -overriding the value of `url-gateway-method'." +overriding the value of `url-gateway-method'. + +The return value of this function is the retrieval buffer." (cl-check-type url vector "Need a pre-parsed URL.") (let* ((host (url-host (or url-using-proxy url))) (port (url-port (or url-using-proxy url)))