]> git.eshelyaron.com Git - emacs.git/commitdiff
Document return value of `display-buffer-in-side-window'
authorMartin Rudalics <rudalics@gmx.at>
Wed, 5 Oct 2016 14:12:19 +0000 (16:12 +0200)
committerMartin Rudalics <rudalics@gmx.at>
Wed, 5 Oct 2016 14:12:19 +0000 (16:12 +0200)
* 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'.

doc/lispref/windows.texi
lisp/window.el

index 1c940dcdac0de61e0bdb52dfad13d2086524dacb..2d340e34cd533cba7ba68810909a66c7d50c48aa 100644 (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:
 
index 4511267149c6f339947092be16b5101f9ba6a2ff..dea0b250a94204142f9b2e29589fa8961744847d 100644 (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