summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorEli Zaretskii <eliz@gnu.org>2016-05-01 18:28:48 +0300
committerEli Zaretskii <eliz@gnu.org>2016-05-01 18:28:48 +0300
commitd38d2a845a8e44443e8d995c0ba79211e6934400 (patch)
treeb5a4e87cd2ac652c70c028c2076f05282b49c1cb /doc
parent586b21393fb1073a91533c25339c4560b0d9e02e (diff)
downloademacs-d38d2a845a8e44443e8d995c0ba79211e6934400.tar.gz
Fix documentation of 'url-retrieve-synchronously'
* doc/misc/url.texi (Retrieving URLs): Update argument list of 'url-retrieve-synchronously'. (Bug#23411)
Diffstat (limited to 'doc')
-rw-r--r--doc/misc/url.texi6
1 files changed, 5 insertions, 1 deletions
diff --git a/doc/misc/url.texi b/doc/misc/url.texi
index c46859968a2..a3c6b88ea05 100644
--- a/doc/misc/url.texi
+++ b/doc/misc/url.texi
@@ -289,11 +289,15 @@ string or a parsed URL structure. If it is a string, that string is
passed through @code{url-encode-url} before using it, to ensure that
it is properly URI-encoded (@pxref{URI Encoding}).
-@defun url-retrieve-synchronously url
+@defun url-retrieve-synchronously url silent no-cookies
This function synchronously retrieves the data specified by @var{url},
and returns a buffer containing the data. The return value is
@code{nil} if there is no data associated with the URL (as is the case
for @code{dired}, @code{info}, and @code{mailto} URLs).
+
+If the optional argument @var{silent} is non-@code{nil}, progress
+messages are suppressed. If the optional argument @var{no-cookies} is
+non-@code{nil}, cookies are not stored or sent.
@end defun
@defun url-retrieve url callback &optional cbargs silent no-cookies