From: Juanma Barranquero <lekktu@gmail.com>
Date: Thu, 24 Oct 2019 19:16:43 +0000 (+0200)
Subject: * doc/lispref/display.texi: Document `delay-warning'
X-Git-Tag: emacs-27.0.90~895^2~6
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=57162dbc065a3b9f9b8dfd555ef628e639061839;p=emacs.git

* doc/lispref/display.texi: Document `delay-warning'
---

diff --git a/doc/lispref/display.texi b/doc/lispref/display.texi
index d7a118296cb..6290c89cdc9 100644
--- a/doc/lispref/display.texi
+++ b/doc/lispref/display.texi
@@ -828,7 +828,13 @@ that warning is not logged.
 
 Sometimes, you may wish to avoid showing a warning while a command is
 running, and only show it only after the end of the command.  You can
-use the variable @code{delayed-warnings-list} for this.
+use the function @code{delay-warning} for this.
+
+@defun delay-warning type message &optional level buffer-name
+This function is the delayed counterpart to @code{display-warning}
+(@pxref{Warning Basics}), and it is called with the same arguments.
+The warning message is queued into @code{delayed-warnings-list}.
+@end defun
 
 @defvar delayed-warnings-list
 The value of this variable is a list of warnings to be displayed after
@@ -840,8 +846,8 @@ the current command has finished.  Each element must be a list
 
 @noindent
 with the same form, and the same meanings, as the argument list of
-@code{display-warning} (@pxref{Warning Basics}).  Immediately after
-running @code{post-command-hook} (@pxref{Command Overview}), the Emacs
+@code{display-warning}.  Immediately after running
+@code{post-command-hook} (@pxref{Command Overview}), the Emacs
 command loop displays all the warnings specified by this variable,
 then resets it to @code{nil}.
 @end defvar