emacs/protesilaos.denote
1
0
Fork 0
mirror of https://github.com/protesilaos/denote.git synced 2026-09-10 07:16:20 -04:00
Code Issues Actions Packages Projects Releases Wiki Activity

Make denote-query-sorting docs more consistent between manual and docstring

Browse source
This commit is contained in:
Protesilaos Stavrou 2025-09-24 13:20:33 +03:00
parent e19538b5c5
commit d1dcab874e
No known key found for this signature in database
GPG key ID: 99BD6459CD5CA3EA
2 changed files with 22 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
README.org
View file

@ -4171,15 +4171,17 @@ they can perform.
#+vindex: denote-query-sorting
The user option ~denote-query-sorting~ controls the order of matching
files in a query buffer (buffers that use the ~denote-query-mode~. The
applies to the buffer that is produced by query links, backlinks, and
the ~denote-grep~ command:
applies to the buffer that is produced by query links for file
contents, backlinks, and the ~denote-grep~ command:
- [[#h:d9a84289-2f73-4ef9-b4f0-9a0aa3e9bf0d][Add a query link]].
- [[#h:c73f1f68-e214-49d5-b369-e694f6a5d708][The backlinks' buffer]].
- [[#h:e71c9d14-7e88-4386-91d0-9ad249947077][Use ~denote-grep~ to search inside files]].
By default, no sorting of matching files is performed. They appear in
the query buffer in the order they were retrieved.
By default (a ~nil~ value), no sorting of matching files is performed.
Files are displayed in the order they are returned by the search
program (which often, but not always, means they are sorted by file
name).
#+vindex: denote-sort-components
The ~denote-query-sorting~ can be set to a symbol among those listed

27
denote.el
View file

@ -5544,21 +5544,26 @@ This is used by the commands `denote-backlinks', `denote-grep',
(defcustom denote-query-sorting nil
"How to sort files in query buffers.
This applies to buffers generated by the `denote-grep' command, query
links for file contents, as well as backlinks.
This applies to buffers generated by `denote-grep' and query links, as
well as backlinks.
By default (a nil value), no sorting of matching files is performed.
Files are displayed in the order they are returned by the search
program (which often, but not always, means they are sorted by file
name).
By default, no sorting is performed, so matching files are displayed as
they are returned by the search program (which often, but not always,
means they are sorted by file name).
The value can be a symbol among those listed in the value of the
variable `denote-sort-components'. Files will then be sorted according
to the given file name component or the relevant method (e.g. randomly
for the `random' symbol).
The user can set this variable to a non-nil value in order to sort the
files in a custom manner. The value is passed as the COMPONENT argument
to the `denote-sort-files' function. That means it can be a symbol
among `denote-sort-components' or a function which performs the sorting.
The value may also be a custom function. It takes two arguments, as
described by `sort' (internally, the function responsible is the
`denote-sort-files').
The user can also call the command `denote-query-sort-last-search' in
order to sort file names interactively in the query buffer."
Whatever the value of `denote-query-sorting', users may change the
sorting of query buffers on demand by calling the command
`denote-query-sort-last-search'."
:type '(radio
(const :tag "Don't sort (default)" nil)
(const :tag "Sort by identifier" identifier)