From: Martin Rudalics <rudalics@gmx.at>
Date: Wed, 5 Oct 2016 14:12:19 +0000 (+0200)
Subject: Document return value of `display-buffer-in-side-window'
X-Git-Tag: emacs-26.0.90~1510
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=9adfb021df482c6aa94a043f07acf1e8eb695bf2;p=emacs.git

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'.
---

diff --git a/doc/lispref/windows.texi b/doc/lispref/windows.texi
index 1c940dcdac0..2d340e34cd5 100644
--- a/doc/lispref/windows.texi
+++ b/doc/lispref/windows.texi
@@ -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:
 
diff --git a/lisp/window.el b/lisp/window.el
index 4511267149c..dea0b250a94 100644
--- a/lisp/window.el
+++ b/lisp/window.el
@@ -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