aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMartin Rudalics2017-10-30 19:43:29 +0100
committerMartin Rudalics2017-10-30 19:43:29 +0100
commitd10c9479ca4d873a8bd09bb63ae865b4a953d5c8 (patch)
treec7a798998e46c9a2dd3f76b7d0bb435057f0c091
parent18331d00da7394f169b842f9e701568fede9b402 (diff)
downloademacs-d10c9479ca4d873a8bd09bb63ae865b4a953d5c8.tar.gz
emacs-d10c9479ca4d873a8bd09bb63ae865b4a953d5c8.zip
Fix doc and doc-strings for minibuffer window related functions (Bug#28978)
These fixes were suggested by Drew Adams. * src/window.c (Fminibuffer_selected_window): Disambiguate doc-string. * doc/lispref/minibuf.texi (Intro to Minibuffers) (Minibuffer Windows, Recursive Mini, Minibuffer Misc): Avoid the term "currently active minibuffer window". Disambiguate documentation of `minibuffer-selected-window'.
-rw-r--r--doc/lispref/minibuf.texi45
-rw-r--r--src/window.c2
2 files changed, 24 insertions, 23 deletions
diff --git a/doc/lispref/minibuf.texi b/doc/lispref/minibuf.texi
index db69e7d8919..75dec13ab7c 100644
--- a/doc/lispref/minibuf.texi
+++ b/doc/lispref/minibuf.texi
@@ -59,15 +59,16 @@ boundary between the prompt and the actual text.
59 59
60@c See https://debbugs.gnu.org/11276 60@c See https://debbugs.gnu.org/11276
61 The minibuffer's window is normally a single line; it grows 61 The minibuffer's window is normally a single line; it grows
62automatically if the contents require more space. Whilst it is 62automatically if the contents require more space. Whilst the minibuffer
63active, you can explicitly resize it temporarily with the window 63is active, you can explicitly resize its window temporarily with the
64sizing commands; it reverts to its normal size when the minibuffer is 64window sizing commands; the window reverts to its normal size when the
65exited. When the minibuffer is not active, you can resize it 65minibuffer is exited. When the minibuffer is not active, you can resize
66permanently by using the window sizing commands in the frame's other 66its window permanently by using the window sizing commands in the
67window, or dragging the mode line with the mouse. (Due to details of 67frame's other window, or dragging the mode line with the mouse. (Due to
68the current implementation, for this to work @code{resize-mini-windows} 68details of the current implementation, for this to work
69must be @code{nil}.) If the frame contains just a minibuffer, you can 69@code{resize-mini-windows} must be @code{nil}.) If the frame contains
70change the minibuffer's size by changing the frame's size. 70just a minibuffer window, you can change its size by changing the
71frame's size.
71 72
72 Use of the minibuffer reads input events, and that alters the values 73 Use of the minibuffer reads input events, and that alters the values
73of variables such as @code{this-command} and @code{last-command} 74of variables such as @code{this-command} and @code{last-command}
@@ -2286,18 +2287,18 @@ The following function returns the window showing the currently active
2286minibuffer. 2287minibuffer.
2287 2288
2288@defun active-minibuffer-window 2289@defun active-minibuffer-window
2289This function returns the currently active minibuffer window, or 2290This function returns the window of the currently active minibuffer, or
2290@code{nil} if there is none. 2291@code{nil} if there is no active minibuffer.
2291@end defun 2292@end defun
2292 2293
2293It is not sufficient to determine whether a given window is the 2294It is not sufficient to determine whether a given window shows the
2294currently active minibuffer window by comparing it with the result of 2295currently active minibuffer by comparing it with the result of
2295@code{(minibuffer-window)}, because there can be more than one 2296@code{(minibuffer-window)}, because there can be more than one
2296minibuffer window if there is more than one frame. 2297minibuffer window if there is more than one frame.
2297 2298
2298@defun minibuffer-window-active-p window 2299@defun minibuffer-window-active-p window
2299This function returns non-@code{nil} if @var{window} is the currently 2300This function returns non-@code{nil} if @var{window} shows the currently
2300active minibuffer window. 2301active minibuffer.
2301@end defun 2302@end defun
2302 2303
2303The following two options control whether minibuffer windows are resized 2304The following two options control whether minibuffer windows are resized
@@ -2379,14 +2380,14 @@ returns zero.
2379 2380
2380@defopt enable-recursive-minibuffers 2381@defopt enable-recursive-minibuffers
2381If this variable is non-@code{nil}, you can invoke commands (such as 2382If this variable is non-@code{nil}, you can invoke commands (such as
2382@code{find-file}) that use minibuffers even while the minibuffer window 2383@code{find-file}) that use minibuffers even while the minibuffer is
2383is active. Such invocation produces a recursive editing level for a new 2384active. Such invocation produces a recursive editing level for a new
2384minibuffer. The outer-level minibuffer is invisible while you are 2385minibuffer. The outer-level minibuffer is invisible while you are
2385editing the inner one. 2386editing the inner one.
2386 2387
2387If this variable is @code{nil}, you cannot invoke minibuffer 2388If this variable is @code{nil}, you cannot invoke minibuffer commands
2388commands when the minibuffer window is active, not even if you switch to 2389when the minibuffer is active, not even if you switch to another window
2389another window to do it. 2390to do it.
2390@end defopt 2391@end defopt
2391 2392
2392@c Emacs 19 feature 2393@c Emacs 19 feature
@@ -2444,8 +2445,8 @@ minibuffer, it scrolls this window.
2444@end defvar 2445@end defvar
2445 2446
2446@defun minibuffer-selected-window 2447@defun minibuffer-selected-window
2447This function returns the window that was selected at the moment the 2448This function returns the window that was selected just before the
2448minibuffer was entered. If the currently selected window is not a 2449minibuffer window was selected. If the selected window is not a
2449minibuffer window, it returns @code{nil}. 2450minibuffer window, it returns @code{nil}.
2450@end defun 2451@end defun
2451 2452
diff --git a/src/window.c b/src/window.c
index f08979e1320..9bb2c43a698 100644
--- a/src/window.c
+++ b/src/window.c
@@ -5832,7 +5832,7 @@ by this function. This happens in an interactive call. */)
5832} 5832}
5833 5833
5834DEFUN ("minibuffer-selected-window", Fminibuffer_selected_window, Sminibuffer_selected_window, 0, 0, 0, 5834DEFUN ("minibuffer-selected-window", Fminibuffer_selected_window, Sminibuffer_selected_window, 0, 0, 0,
5835 doc: /* Return the window which was selected when entering the minibuffer. 5835 doc: /* Return window selected just before minibuffer window was selected.
5836Return nil if the selected window is not a minibuffer window. */) 5836Return nil if the selected window is not a minibuffer window. */)
5837 (void) 5837 (void)
5838{ 5838{