From: Eli Zaretskii <eliz@gnu.org>
Date: Fri, 6 Aug 2021 07:22:22 +0000 (+0300)
Subject: Improve wording of recently changed documentation
X-Git-Tag: emacs-28.0.90~1591^2~16
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=c327d61ec86023aaf6b014259db301f081a0e034;p=emacs.git

Improve wording of recently changed documentation

* src/minibuf.c (syms_of_minibuf):
* lisp/minibuffer.el (minibuffer-restore-windows):
* lisp/progmodes/etags.el (etags-xref-prefer-current-file):
Improve wording of doc strings.

* etc/NEWS: Improve wording and format of recently added entries.
---

diff --git a/etc/NEWS b/etc/NEWS
index 7fc53ff6c01..674152c8c8a 100644
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -181,7 +181,8 @@ nor t.
 +++
 ** New user option 'read-minibuffer-restore-windows'.
 When customized to nil, it uses 'minibuffer-restore-windows' in
-'minibuffer-exit-hook' to remove only the *Completions* window.
+'minibuffer-exit-hook' to remove only the window showing the
+"*Completions*" buffer.
 
 +++
 ** New system for displaying documentation for groups of functions.
@@ -2074,11 +2075,12 @@ project's root directory, respectively.
 This command lets you interactively remove an entry from the list of projects
 in 'project-list-file'.
 
-*** 'project-find-file' now accepts non-existent file names (to
-facilitate creating a file inside some nested sub-directory easily).
+*** 'project-find-file' now accepts non-existent file names.
+This is to allow easy creation of files inside some nested
+sub-directory.
 
-*** 'project-find-file' doesn't use the string at point as default
-input, now it's only suggested as part of "future history".
+*** 'project-find-file' doesn't use the string at point as default input.
+Now it's only suggested as part of the "future history".
 
 ** xref
 
@@ -3695,8 +3697,10 @@ Emacs constructs the nondirectory part of the auto-save file name by
 applying that 'secure-hash' to the buffer file name.  This avoids any
 risk of excessively long file names.
 
-** New variable 'etags-xref-prefer-current-file' to change the order
-of definitions returned by the etags Xref backend.
+---
+** New user option 'etags-xref-prefer-current-file'.
+When non-nil, matches for identifiers in the file visited by the
+current buffer will be shown first in the "*xref*" buffer.
 
 
 * Changes in Emacs 28.1 on Non-Free Operating Systems
diff --git a/lisp/minibuffer.el b/lisp/minibuffer.el
index 3258e1ec8da..2c6340e1c3e 100644
--- a/lisp/minibuffer.el
+++ b/lisp/minibuffer.el
@@ -2332,7 +2332,7 @@ variables.")
   "Restore some windows on exit from minibuffer.
 When `read-minibuffer-restore-windows' is nil, then this function
 added to `minibuffer-exit-hook' will remove at least the window
-with the *Completions* buffer."
+that displays the \"*Completions*\" buffer."
   (unless read-minibuffer-restore-windows
     (minibuffer-hide-completions)))
 
diff --git a/lisp/progmodes/etags.el b/lisp/progmodes/etags.el
index 3ea1131db58..a1f806ae8c9 100644
--- a/lisp/progmodes/etags.el
+++ b/lisp/progmodes/etags.el
@@ -2060,7 +2060,7 @@ If you want `xref-find-definitions' to find the tagged files by their
 file name, add `tag-partial-file-name-match-p' to the list value.")
 
 (defcustom etags-xref-prefer-current-file nil
-  "Non-nil to show the matches in the current file first."
+  "Non-nil means show the matches in the current file first."
   :type 'boolean
   :version "28.1")
 
diff --git a/src/minibuf.c b/src/minibuf.c
index a054f0e20dc..c9134eff67f 100644
--- a/src/minibuf.c
+++ b/src/minibuf.c
@@ -2537,9 +2537,10 @@ restore, on exit, the window configurations of the frame where the
 minibuffer was entered from and, if it is different, the frame that owns
 the associated minibuffer window.
 
-If this is nil, no such restorations are done.
-But still `minibuffer-restore-windows' in `minibuffer-exit-hook'
-will remove the window with the *Completions* buffer.  */);
+If this is nil, window configurations are not restored upon exiting
+the minibuffer.  However, if `minibuffer-restore-windows' is present
+in `minibuffer-exit-hook', exiting the minibuffer will remove the window
+showing the *Completions* buffer, if any.  */);
   read_minibuffer_restore_windows = true;
 
   defsubr (&Sactive_minibuffer_window);