Document return value of `display-buffer-in-side-window'

* doc/lispref/windows.texi (Displaying Buffers in Side Windows):
* lisp/window.el (display-buffer-in-side-window): Describe
return value of `display-buffer-in-side-window'.
This commit is contained in:
Martin Rudalics 2016-10-05 16:12:19 +02:00
parent 0709b900f5
commit 9adfb021df
2 changed files with 6 additions and 3 deletions

View file

@ -3117,7 +3117,10 @@ specified buffer.
@defun display-buffer-in-side-window buffer alist
This function displays @var{buffer} in a side window of the selected
frame. @var{alist} is an association list of symbols and values as for
frame. It returns the window used for displaying @var{buffer},
@code{nil} if no such window can be found or created.
@var{alist} is an association list of symbols and values as for
@code{display-buffer}. The following symbols in @var{alist} are special
for this function:

View file

@ -979,8 +979,8 @@ 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 nil if no
suitable window is found.
dedicate the side window used to BUFFER. Return the window used
for displaying BUFFER, nil if no suitable window can be found.
This function installs the `window-side' and `window-slot'
parameters and makes them persistent. It neither modifies ALIST