summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMartin Rudalics <rudalics@gmx.at>2017-12-07 09:55:21 +0100
committerMartin Rudalics <rudalics@gmx.at>2017-12-07 09:55:21 +0100
commit05720162c1616ca76093f5569e3081dc515993a9 (patch)
tree3f806a44b7e1f9253eb7bd7b5bb285ffa7d87a46
parenta1bbc490155b61a634a6d0b165000ce35b93aa35 (diff)
downloademacs-05720162c1616ca76093f5569e3081dc515993a9.tar.gz
Fix doc-string of 'display-buffer-in-side-window'
* lisp/window.el (display-buffer-in-side-window): In doc-string clarify why the window returned gets dedicated to its buffer.
-rw-r--r--lisp/window.el5
1 files changed, 3 insertions, 2 deletions
diff --git a/lisp/window.el b/lisp/window.el
index b7736d85cd1..c4572106f45 100644
--- a/lisp/window.el
+++ b/lisp/window.el
@@ -1008,8 +1008,9 @@ do not permit making a new window, a suitable existing window may
be reused and have its `window-slot' parameter value accordingly
modified.
-Unless `display-buffer-mark-dedicated' is non-nil, softly
-dedicate the side window used to BUFFER. Return the window used
+Unless `display-buffer-mark-dedicated' is non-nil, dedicate the
+side window used to BUFFER so that it does not get reused by
+other `display-buffer' action functions. Return the window used
for displaying BUFFER, nil if no suitable window can be found.
This function installs the `window-side' and `window-slot'