[Emacs-diffs] master 2f5e809: Clarify documentation of 'get-buffer-window-list'

[Eli Zaretskii]

branch: master
commit 2f5e8090824d7d1ca8894c12a1e51e2ad340c012
Author: Eli Zaretskii <address@hidden>
Commit: Eli Zaretskii <address@hidden>

    Clarify documentation of 'get-buffer-window-list'
    
    * doc/lispref/windows.texi (Buffers and Windows): Mention that the
    current window, if relevant, will be the first in the list
    returned by 'get-buffer-window-list'.
    
    * lisp/window.el (get-buffer-window-list): Doc fix.  (Bug#21305)
---
 doc/lispref/windows.texi |    4 +++-
 lisp/window.el           |    4 ++--
 2 files changed, 5 insertions(+), 3 deletions(-)

diff --git a/doc/lispref/windows.texi b/doc/lispref/windows.texi
index f809678..9cd59d7 100644
--- a/doc/lispref/windows.texi
+++ b/doc/lispref/windows.texi
@@ -1984,7 +1984,9 @@ to eliminate this discrepancy.
 This function returns a list of all windows currently displaying
 @var{buffer-or-name}.  @var{buffer-or-name} should be a buffer or the
 name of an existing buffer.  If omitted or @code{nil}, it defaults to
-the current buffer.
+the current buffer.  If the currently selected window displays
address@hidden, it will be the first in the list returned by
+this function.
 
 The arguments @var{minibuf} and @var{all-frames} have the same
 meanings as in the function @code{next-window} (@pxref{Cyclic Window
diff --git a/lisp/window.el b/lisp/window.el
index c783b0d..d39c701 100644
--- a/lisp/window.el
+++ b/lisp/window.el
@@ -2299,8 +2299,8 @@ selected frame and no others."
 (defun get-buffer-window-list (&optional buffer-or-name minibuf all-frames)
   "Return list of all windows displaying BUFFER-OR-NAME, or nil if none.
 BUFFER-OR-NAME may be a buffer or the name of an existing buffer
-and defaults to the current buffer.  Windows are scanned starting
-with the selected window.
+and defaults to the current buffer.  If the selected window displays
+BUFFER-OR-NAME, it will be the first in the resulting list.
 
 MINIBUF t means include the minibuffer window even if the
 minibuffer is not active.  MINIBUF nil or omitted means include