Improve recently-changed docs

* src/frame.c (Fnext_frame):
* doc/lispref/frames.texi (Finding All Frames): Improve wording
and style of the 'next-frame's documentation.
This commit is contained in:
Eli Zaretskii 2021-08-23 19:11:49 +03:00
parent 9936e1478f
commit efddcc9fbe
2 changed files with 13 additions and 14 deletions

View file

@ -2692,21 +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 include when
considering what the next frame should be:
The second argument, @var{minibuf}, says which frames to consider when
deciding what the next frame should be:
@table @asis
@item @code{nil}
Include all frames except minibuffer-only frames.
Consider all frames except minibuffer-only frames.
@item @code{visible}
Include only visible frames.
Consider only visible frames.
@item 0
Include only visible or iconified frames.
Consider only visible or iconified frames.
@item a window
Include only the frames using that particular window as their
minibuffer.
Consider only the frames using that particular window as their
minibuffer window.
@item anything else
Include all frames.
Consider all frames.
@end table
@end defun

View file

@ -1837,8 +1837,8 @@ prev_frame (Lisp_Object frame, Lisp_Object minibuf)
DEFUN ("next-frame", Fnext_frame, Snext_frame, 0, 2, 0,
doc: /* Return the next frame in the frame list after FRAME.
Only frames on the same terminal as FRAME are included. If omitted,
FRAME defaults to the selected frame.
Only frames on the same terminal as FRAME are included in the list
of candidate frames. If omitted, FRAME defaults to the selected frame.
If MINIFRAME is nil (the default), include all frames except
minibuffer-only frames.
@ -1846,12 +1846,11 @@ minibuffer-only frames.
If MINIFRAME is a window, include only its own frame and any frame now
using that window as the minibuffer.
If MINIFRAME is `visible', only include visible frames.
If MINIFRAME is `visible', include only visible frames.
If MINIFRAME is 0, only include visible and iconified frames.
If MINIFRAME is 0, include only visible and iconified frames.
If MINIFRAME is any other value than these values, include all
frames. */)
If MINIFRAME is any other value, include all frames. */)
(Lisp_Object frame, Lisp_Object miniframe)
{
if (NILP (frame))