From: Juri Linkov <juri@linkov.net>
Date: Sun, 9 Jun 2024 17:03:32 +0000 (+0300)
Subject: Text improvements for the documentation of 'some-window' (bug#70949)
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=97414182773cc489c9a4af74e222bbea22fc5758;p=emacs.git

Text improvements for the documentation of 'some-window' (bug#70949)

* doc/lispref/windows.texi (Buffer Display Action Functions):
Improve wording.  Suggested by martin rudalics <rudalics@gmx.at>.

(cherry picked from commit 8254e50e2d892453004d453c58b54947d14f123a)
---

diff --git a/doc/lispref/windows.texi b/doc/lispref/windows.texi
index ef61e2780c1..01ec2a6ecd5 100644
--- a/doc/lispref/windows.texi
+++ b/doc/lispref/windows.texi
@@ -2806,16 +2806,16 @@ some other window, preferably a large window on some visible frame.  It
 can fail if all windows are dedicated to other buffers (@pxref{Dedicated
 Windows}).
 
-The above describes the behavior when @code{some-window} @var{alist}
-entry is @code{lru} or @code{nil} which is the default.  But when,
-for example, @code{display-buffer-base-action} is customized to
-@w{@code{(nil . ((some-window . mru)))}}, then the value @code{mru}
-means that this function will prefer the most recently used window
-that is useful to display several buffers from the consecutive calls
-of @code{display-buffer} in the same window.  Consider a configuration
-of three or more windows where a user wants to consult, in
-a non-selected window, one after the other, the results of a query
-spread among several buffers.  With the @code{lru} strategy, Emacs might
+The above describes the behavior when the @code{some-window} @var{alist}
+entry is @code{lru} or @code{nil} which is the default.  Another
+possible value is @code{mru}.  If, for example,
+@code{display-buffer-base-action} is customized to @w{@code{(nil
+. ((some-window . mru)))}}, then this function will prefer the most
+recently used window.  This will try to display several buffers from
+consecutive calls of @code{display-buffer} in the same window.  Consider
+a configuration of three or more windows where a user wants to consult,
+in a non-selected window, one after the other, the results of a query
+spread among several buffers.  With the @code{lru} strategy, Emacs may
 continuously choose another window because the least recently used
 window changes with every call of @code{display-buffer-use-some-window}.
 With the @code{mru} strategy, the window chosen would always remain the
diff --git a/etc/NEWS b/etc/NEWS
index a01f45f5359..1014beec3bc 100644
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -311,11 +311,11 @@ right-aligned to is controlled by the new user option
 
 +++
 *** New action alist entry 'some-window' for 'display-buffer'.
-It defines which window 'display-buffer-use-some-window' should prefer.
+It specifies which window 'display-buffer-use-some-window' should prefer.
 For example, when 'display-buffer-base-action' is customized to
-'(nil . ((some-window . mru)))' then a buffer will be displayed
-in the same most recently used window from the consecutive calls
-display-buffer' (on a configuration with more than two windows).
+'(nil . ((some-window . mru)))', then a buffer will be displayed
+in the same most recently used window from consecutive calls of
+'display-buffer' (in a configuration with more than two windows).
 
 +++
 *** New action alist entry 'category' for 'display-buffer'.