From: Eli Zaretskii Date: Fri, 21 Aug 2015 12:55:05 +0000 (+0300) Subject: Clarify documentation of 'get-buffer-window-list' X-Git-Tag: emacs-25.0.90~1323 X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=2f5e8090824d7d1ca8894c12a1e51e2ad340c012;p=emacs.git 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) --- diff --git a/doc/lispref/windows.texi b/doc/lispref/windows.texi index f809678f5c4..9cd59d70505 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 +@var{buffer-or-name}, 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 c783b0d5b10..d39c7018601 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