diff options
| author | Eli Zaretskii | 2019-12-22 21:02:48 +0200 |
|---|---|---|
| committer | Eli Zaretskii | 2019-12-22 21:02:48 +0200 |
| commit | d7ab4edd93d44b33df72a4697b4628ee1133ca41 (patch) | |
| tree | dd88ab8aa5f107469b9d4765046aa903afb51a7e /doc | |
| parent | 753389448de3b0da608f0631349aa84c2281ee1f (diff) | |
| download | emacs-d7ab4edd93d44b33df72a4697b4628ee1133ca41.tar.gz emacs-d7ab4edd93d44b33df72a4697b4628ee1133ca41.zip | |
Fix wording of recent documentation changes
* src/xdisp.c (syms_of_xdisp):
* lisp/minibuffer.el (minibuffer-message-clear-timeout):
* etc/NEWS:
* doc/lispref/display.texi (Displaying Messages): Minor
changes of wording of a recent commit. (Bug#38457)
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/lispref/display.texi | 31 |
1 files changed, 16 insertions, 15 deletions
diff --git a/doc/lispref/display.texi b/doc/lispref/display.texi index 0085f3b6750..6952cb58130 100644 --- a/doc/lispref/display.texi +++ b/doc/lispref/display.texi | |||
| @@ -307,28 +307,29 @@ reformatted, with undesirable results. Instead, use @code{(message | |||
| 307 | @end defun | 307 | @end defun |
| 308 | 308 | ||
| 309 | @defvar set-message-function | 309 | @defvar set-message-function |
| 310 | When this variable is non-@code{nil}, @code{message} and related functions | 310 | If this variable is non-@code{nil}, it should be a function of one |
| 311 | call it as a function with one argument that is the message to show. | 311 | argument, the text of a message to display in the echo area. This |
| 312 | 312 | function will be called by @code{message} and related functions. If | |
| 313 | When this function returns @code{nil}, the message is displayed in the | 313 | the function returns @code{nil}, the message is displayed in the echo |
| 314 | echo area as usual. When the function returns a string, the returned | 314 | area as usual. If this function returns a string, that string is |
| 315 | string is displayed in the echo area. When this function returns | 315 | displayed in the echo area instead of the original one. If this |
| 316 | other non-@code{nil} values, this means that the message was handled | 316 | function returns other non-@code{nil} values, that means the message |
| 317 | specially, so the same message is not displayed in the echo area. | 317 | was already handled, so @code{message} will not display anything in |
| 318 | See also @code{clear-message-function} that can be used to clear the | 318 | the echo area. See also @code{clear-message-function} that can be |
| 319 | message displayed by this function. | 319 | used to clear the message displayed by this function. |
| 320 | 320 | ||
| 321 | The default value is the function that displays the message at the end | 321 | The default value is the function that displays the message at the end |
| 322 | of the minibuffer when the minibuffer is active. | 322 | of the minibuffer when the minibuffer is active. |
| 323 | @end defvar | 323 | @end defvar |
| 324 | 324 | ||
| 325 | @defvar clear-message-function | 325 | @defvar clear-message-function |
| 326 | When this variable is non-@code{nil}, @code{message} and related functions | 326 | If this variable is non-@code{nil}, @code{message} and related |
| 327 | call it without arguments when their message is @code{nil} or the empty string. | 327 | functions call it with no arguments when their argument message is |
| 328 | @code{nil} or the empty string. | ||
| 328 | 329 | ||
| 329 | Usually this function is called when the next input event arrives. | 330 | Usually this function is called when the next input event arrives |
| 330 | The function is called without arguments. It is expected to clear the | 331 | after displaying an echo-area message. The function is expected to |
| 331 | message displayed by its counterpart function specified by | 332 | clear the message displayed by its counterpart function specified by |
| 332 | @code{set-message-function}. | 333 | @code{set-message-function}. |
| 333 | 334 | ||
| 334 | The default value is the function that clears the message displayed at | 335 | The default value is the function that clears the message displayed at |