mirrors/emacs
1
Fork 0
mirror of git://git.sv.gnu.org/emacs.git synced 2025-12-15 10:30:25 -08:00
Code Issues Projects Releases Wiki Activity

Clarify the documentation of `next-frame'

Browse source 
* doc/lispref/frames.texi (Finding All Frames): Clarify what it
means to "consider".
* src/frame.c (Fnext_frame): Rewrite doc string to say what the
parameters actually mean (bug#13339).
This commit is contained in:
Lars Ingebrigtsen 2021-08-23 16:32:33 +02:00
parent 591b8bd87a
commit 4167d4b4b2
2 changed files with 22 additions and 15 deletions
Download patch file Download diff file Expand all files Collapse all files

13
doc/lispref/frames.texi
View file

@ -2692,20 +2692,21 @@ frame and defaults to the selected frame. It never returns a frame
whose @code{no-other-frame} parameter (@pxref{Frame Interaction
Parameters}) is non-@code{nil}.
The second argument, @var{minibuf}, says which frames to consider:
The second argument, @var{minibuf}, says which frames to include when
considering what the next frame should be:
@table @asis
@item @code{nil}
Exclude minibuffer-only frames.
Include all frames except minibuffer-only frames.
@item @code{visible}
Consider all visible frames.
Include only visible frames.
@item 0
Consider all visible or iconified frames.
Include only visible or iconified frames.
@item a window
Consider only the frames using that particular window as their
Include only the frames using that particular window as their
minibuffer.
@item anything else
Consider all frames.
Include all frames.
@end table
@end defun