diff options
| author | Juanma Barranquero | 2019-10-24 21:16:43 +0200 |
|---|---|---|
| committer | Juanma Barranquero | 2019-10-24 21:16:43 +0200 |
| commit | 57162dbc065a3b9f9b8dfd555ef628e639061839 (patch) | |
| tree | 5d8a3d29bc2cf1f298f9de92e485ecccd4bd5810 | |
| parent | 539d0411bb04e5b3b32cd77ac3b3e4ad364589da (diff) | |
| download | emacs-57162dbc065a3b9f9b8dfd555ef628e639061839.tar.gz emacs-57162dbc065a3b9f9b8dfd555ef628e639061839.zip | |
* doc/lispref/display.texi: Document `delay-warning'
| -rw-r--r-- | doc/lispref/display.texi | 12 |
1 files changed, 9 insertions, 3 deletions
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. | |||
| 828 | 828 | ||
| 829 | Sometimes, you may wish to avoid showing a warning while a command is | 829 | Sometimes, you may wish to avoid showing a warning while a command is |
| 830 | running, and only show it only after the end of the command. You can | 830 | running, and only show it only after the end of the command. You can |
| 831 | use the variable @code{delayed-warnings-list} for this. | 831 | use the function @code{delay-warning} for this. |
| 832 | |||
| 833 | @defun delay-warning type message &optional level buffer-name | ||
| 834 | This function is the delayed counterpart to @code{display-warning} | ||
| 835 | (@pxref{Warning Basics}), and it is called with the same arguments. | ||
| 836 | The warning message is queued into @code{delayed-warnings-list}. | ||
| 837 | @end defun | ||
| 832 | 838 | ||
| 833 | @defvar delayed-warnings-list | 839 | @defvar delayed-warnings-list |
| 834 | The value of this variable is a list of warnings to be displayed after | 840 | 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 | |||
| 840 | 846 | ||
| 841 | @noindent | 847 | @noindent |
| 842 | with the same form, and the same meanings, as the argument list of | 848 | with the same form, and the same meanings, as the argument list of |
| 843 | @code{display-warning} (@pxref{Warning Basics}). Immediately after | 849 | @code{display-warning}. Immediately after running |
| 844 | running @code{post-command-hook} (@pxref{Command Overview}), the Emacs | 850 | @code{post-command-hook} (@pxref{Command Overview}), the Emacs |
| 845 | command loop displays all the warnings specified by this variable, | 851 | command loop displays all the warnings specified by this variable, |
| 846 | then resets it to @code{nil}. | 852 | then resets it to @code{nil}. |
| 847 | @end defvar | 853 | @end defvar |