]> git.eshelyaron.com Git - emacs.git/commitdiff
; Fix documentation of last change
authorEli Zaretskii <eliz@gnu.org>
Thu, 4 Jan 2024 18:47:06 +0000 (20:47 +0200)
committerEshel Yaron <me@eshelyaron.com>
Thu, 4 Jan 2024 21:22:33 +0000 (22:22 +0100)
* lisp/minibuffer.el (completion-category-overrides): Doc fix.

* doc/emacs/mini.texi (Completion Options): Update documentation
of 'completions-sort'.
* doc/lispref/minibuf.texi (Completion Variables): Fox wording.
Add a cross-reference to where 'completions-sort' is documented.

(cherry picked from commit df505804ab6e7dc869cfc9db6308a8c568eddd6a)

doc/lispref/minibuf.texi
lisp/minibuffer.el

index 3ca1a8ca75d330a52d593717686363f47599c826..f7122325fb525ed18aa4ae2e3648d0dbc7c9f725 100644 (file)
@@ -1987,10 +1987,12 @@ The value should be a value for @code{completion-cycle-threshold}
 category.
 
 @item display-sort-function
-The possible values are: @code{nil} that means to use either the sorting
-function from metadata or if it's nil then fall back to @code{completions-sort};
-@code{identity} that means to not use any sorting to keep the original order;
-and other values are the same as in @code{completions-sort}.
+The possible values are: @code{nil}, which means to use either the
+sorting function from metadata or if that is @code{nil}, fall back to
+@code{completions-sort}; @code{identity}, which means not to sort at
+all, leaving the original order; or any other value out of those used
+in @code{completions-sort} (@pxref{Completion Options,,, emacs, The
+GNU Emacs Manual}).
 @end table
 
 @noindent
index 2c2ea2360829d1b28a491b8fb47643d80579f48b..8ae9ec295f3da2968918fb16c02f78c91cd09aad 100644 (file)
@@ -1158,10 +1158,10 @@ Each override has the shape (CATEGORY . ALIST) where ALIST is
 an association list that can specify properties such as:
 - `styles': the list of `completion-styles' to use for that category.
 - `cycle': the `completion-cycle-threshold' to use for that category.
-- `display-sort-function': where `nil' means to use either the sorting
-function from metadata or if it's nil then fall back to `completions-sort';
-`identity' means to not use any sorting to keep the original order;
-and other values are the same as in `completions-sort'.
+- `display-sort-function': nil means to use either the sorting
+function from metadata, or if that is nil, fall back to `completions-sort';
+`identity' disables sorting and keeps the original order; and other
+possible values are the same as in `completions-sort'.
 
 Categories are symbols such as `buffer' and `file', used when
 completing buffer and file names, respectively.