diff options
| author | Devon Sean McCullough | 2015-12-25 22:21:22 +0100 |
|---|---|---|
| committer | Noam Postavsky | 2016-10-02 12:27:32 -0400 |
| commit | e6834952edbd8b4e00c2e7b06535778fb6a1865b (patch) | |
| tree | 4f26a539a6a2d3810513885cf3e391fd3121458f | |
| parent | f1247f069e6a908595748c315948c636962b60dc (diff) | |
| download | emacs-e6834952edbd8b4e00c2e7b06535778fb6a1865b.tar.gz emacs-e6834952edbd8b4e00c2e7b06535778fb6a1865b.zip | |
Doc fix for url-http
* lisp/url/url-http.el (url-http): Document better return values
(bug#13187) (tiny change)
(cherry picked from commit 344303c8d9cb03d4778a73940e80e966280aa694)
| -rw-r--r-- | lisp/url/url-http.el | 15 |
1 files changed, 9 insertions, 6 deletions
diff --git a/lisp/url/url-http.el b/lisp/url/url-http.el index 8f36ddeafbf..e0e080e76af 100644 --- a/lisp/url/url-http.el +++ b/lisp/url/url-http.el | |||
| @@ -1195,17 +1195,20 @@ the end of the document." | |||
| 1195 | "Retrieve URL via HTTP asynchronously. | 1195 | "Retrieve URL via HTTP asynchronously. |
| 1196 | URL must be a parsed URL. See `url-generic-parse-url' for details. | 1196 | URL must be a parsed URL. See `url-generic-parse-url' for details. |
| 1197 | 1197 | ||
| 1198 | When retrieval is completed, execute the function CALLBACK, passing it | 1198 | When retrieval is completed, execute the function CALLBACK, |
| 1199 | an updated value of CBARGS as arguments. The first element in CBARGS | 1199 | passing it an updated value of CBARGS as arguments. The first |
| 1200 | should be a plist describing what has happened so far during the | 1200 | element in CBARGS should be a plist describing what has happened |
| 1201 | request, as described in the docstring of `url-retrieve' (if in | 1201 | so far during the request, as described in the docstring of |
| 1202 | doubt, specify nil). | 1202 | `url-retrieve' (if in doubt, specify nil). The current buffer |
| 1203 | then CALLBACK is executed is the retrieval buffer. | ||
| 1203 | 1204 | ||
| 1204 | Optional arg RETRY-BUFFER, if non-nil, specifies the buffer of a | 1205 | Optional arg RETRY-BUFFER, if non-nil, specifies the buffer of a |
| 1205 | previous `url-http' call, which is being re-attempted. | 1206 | previous `url-http' call, which is being re-attempted. |
| 1206 | 1207 | ||
| 1207 | Optional arg GATEWAY-METHOD specifies the gateway to be used, | 1208 | Optional arg GATEWAY-METHOD specifies the gateway to be used, |
| 1208 | overriding the value of `url-gateway-method'." | 1209 | overriding the value of `url-gateway-method'. |
| 1210 | |||
| 1211 | The return value of this function is the retrieval buffer." | ||
| 1209 | (cl-check-type url vector "Need a pre-parsed URL.") | 1212 | (cl-check-type url vector "Need a pre-parsed URL.") |
| 1210 | (let* ((host (url-host (or url-using-proxy url))) | 1213 | (let* ((host (url-host (or url-using-proxy url))) |
| 1211 | (port (url-port (or url-using-proxy url))) | 1214 | (port (url-port (or url-using-proxy url))) |