aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorEli Zaretskii2015-12-19 13:34:34 +0200
committerEli Zaretskii2015-12-19 13:34:34 +0200
commit7de84646df80b559daec11e59acde3cf5ad5759e (patch)
tree745f1e965e7f6dc456da3e319a90bef5fd9b664c
parentf1c721a0adc67bafba75e93e00fe4273e653c5e5 (diff)
downloademacs-7de84646df80b559daec11e59acde3cf5ad5759e.tar.gz
emacs-7de84646df80b559daec11e59acde3cf5ad5759e.zip
Clarify doc string of 'display-message-or-buffer'
* lisp/simple.el (display-message-or-buffer): Doc fix. Suggested by Sebastian Wiesner <swiesner@lunaryorn.com>. (Bug#22210)
-rw-r--r--lisp/simple.el11
1 files changed, 5 insertions, 6 deletions
diff --git a/lisp/simple.el b/lisp/simple.el
index 9e0388efe45..2abab5c597c 100644
--- a/lisp/simple.el
+++ b/lisp/simple.el
@@ -3360,13 +3360,12 @@ the use of a shell (with its need to quote arguments)."
3360 (shell-command-on-region (point) (point) command 3360 (shell-command-on-region (point) (point) command
3361 output-buffer nil error-buffer))))))) 3361 output-buffer nil error-buffer)))))))
3362 3362
3363(defun display-message-or-buffer (message 3363(defun display-message-or-buffer (message &optional buffer-name action frame)
3364 &optional buffer-name not-this-window frame)
3365 "Display MESSAGE in the echo area if possible, otherwise in a pop-up buffer. 3364 "Display MESSAGE in the echo area if possible, otherwise in a pop-up buffer.
3366MESSAGE may be either a string or a buffer. 3365MESSAGE may be either a string or a buffer.
3367 3366
3368A buffer is displayed using `display-buffer' if MESSAGE is too long for 3367A pop-up buffer is displayed using `display-buffer' if MESSAGE is too long
3369the maximum height of the echo area, as defined by `max-mini-window-height' 3368for maximum height of the echo area, as defined by `max-mini-window-height'
3370if `resize-mini-windows' is non-nil. 3369if `resize-mini-windows' is non-nil.
3371 3370
3372Returns either the string shown in the echo area, or when a pop-up 3371Returns either the string shown in the echo area, or when a pop-up
@@ -3378,8 +3377,8 @@ is used, defaulting to `*Message*'. In the case where MESSAGE is a
3378string and it is displayed in the echo area, it is not specified whether 3377string and it is displayed in the echo area, it is not specified whether
3379the contents are inserted into the buffer anyway. 3378the contents are inserted into the buffer anyway.
3380 3379
3381Optional arguments NOT-THIS-WINDOW and FRAME are as for `display-buffer', 3380Optional arguments ACTION and FRAME are as for `display-buffer',
3382and only used if a buffer is displayed." 3381and are only used if a pop-up buffer is displayed."
3383 (cond ((and (stringp message) (not (string-match "\n" message))) 3382 (cond ((and (stringp message) (not (string-match "\n" message)))
3384 ;; Trivial case where we can use the echo area 3383 ;; Trivial case where we can use the echo area
3385 (message "%s" message)) 3384 (message "%s" message))