]> git.eshelyaron.com Git - emacs.git/commitdiff
Fix documentation of window-in-direction arg MINIBUF (bug#44932)
authorJuri Linkov <juri@linkov.net>
Tue, 1 Dec 2020 20:33:43 +0000 (22:33 +0200)
committerJuri Linkov <juri@linkov.net>
Tue, 1 Dec 2020 20:33:43 +0000 (22:33 +0200)
* doc/lispref/windows.texi (Windows and Frames): Rename MINI arg
of window-in-direction to MINIBUF.  Explain the non-nil non-t value.

doc/lispref/windows.texi

index 2d092e1842aba5690cab0935b18e3e980874f76d..db80b49507f6fa9eac37955b2663ec4ab4499010 100644 (file)
@@ -365,7 +365,7 @@ appears right below @var{window}.
 @end defun
 
 @cindex window in direction
-@defun window-in-direction direction &optional window ignore sign wrap mini
+@defun window-in-direction direction &optional window ignore sign wrap minibuf
 This function returns the nearest live window in direction
 @var{direction} as seen from the position of @code{window-point} in
 window @var{window}.  The argument @var{direction} must be one of
@@ -392,11 +392,13 @@ is at the top of the frame and @var{direction} is @code{above}, then
 this function usually returns the frame's minibuffer window if it's
 active and a window at the bottom of the frame otherwise.
 
-If the optional argument @var{mini} is @code{nil}, this means to return
-the minibuffer window if and only if it is currently active.  If
-@var{mini} is non-@code{nil}, this function may return the minibuffer
-window even when it's not active.  However, if @var{wrap} is
-non-@code{nil}, it always acts as if @var{mini} were @code{nil}.
+If the optional argument @var{minibuf} is @code{t}, this function may
+return the minibuffer window even when it's not active.  If the
+optional argument @var{minibuf} is @code{nil}, this means to return
+the minibuffer window if and only if it is currently active.
+If @var{minibuf} is neither @code{nil} nor @code{t}, this function
+never returns the minibuffer window.  However, if @var{wrap} is
+non-@code{nil}, it always acts as if @var{minibuf} were @code{nil}.
 
 If it doesn't find a suitable window, this function returns
 @code{nil}.