From efddcc9fbef9e3b11362cc05b12d3e378a0b11c4 Mon Sep 17 00:00:00 2001 From: Eli Zaretskii Date: Mon, 23 Aug 2021 19:11:49 +0300 Subject: [PATCH] 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. --- doc/lispref/frames.texi | 16 ++++++++-------- src/frame.c | 11 +++++------ 2 files changed, 13 insertions(+), 14 deletions(-) diff --git a/doc/lispref/frames.texi b/doc/lispref/frames.texi index 596585f99bb..477c105a950 100644 --- a/doc/lispref/frames.texi +++ b/doc/lispref/frames.texi @@ -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 diff --git a/src/frame.c b/src/frame.c index c6b4c5946cb..74ef2afdb1d 100644 --- a/src/frame.c +++ b/src/frame.c @@ -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)) -- 2.39.5