]> code.delx.au - gnu-emacs/commitdiff
Fix documentation of 'url-retrieve-synchronously'
authorEli Zaretskii <eliz@gnu.org>
Sun, 1 May 2016 15:28:48 +0000 (18:28 +0300)
committerEli Zaretskii <eliz@gnu.org>
Sun, 1 May 2016 15:28:48 +0000 (18:28 +0300)
* doc/misc/url.texi (Retrieving URLs): Update argument list of
'url-retrieve-synchronously'.  (Bug#23411)

doc/misc/url.texi

index c46859968a2e40bc98afa91fc5c3a62ed106e0b6..a3c6b88ea05d3f43f8c1d02318f1c49947c6e4a9 100644 (file)
@@ -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