emacs: update defcustom for notmuch-search-result-format.

It seems redundant to have the previous example, since the default
value is always show by describe variable.

Enforce more restrictions on the keys in the alist, since arbitrary
strings don't work as field names.

Document that functions can be used in lieu of field names.
This commit is contained in:
David Bremner 2022-07-16 17:22:23 -04:00
parent 1ef7c75111
commit 4237409faf

View file

@ -90,11 +90,11 @@
("tags" . "(%s)")) ("tags" . "(%s)"))
"Search result formatting. "Search result formatting.
Supported fields are: date, count, authors, subject, tags. List of pairs of (field . format-string). Supported field
For example: strings are: \"date\", \"count\", \"authors\", \"subject\",
(setq notmuch-search-result-format \"tags\". It is also supported to pass a function in place of a
\\='((\"authors\" . \"%-40s\") field name. In this case the function is passed the thread
(\"subject\" . \"%s\"))) object (plist) and format string.
Line breaks are permitted in format strings (though this is Line breaks are permitted in format strings (though this is
currently experimental). Note that a line break at the end of an currently experimental). Note that a line break at the end of an
@ -102,7 +102,16 @@ currently experimental). Note that a line break at the end of an
place it instead at the beginning of the following field. To place it instead at the beginning of the following field. To
enter a line break when setting this variable with setq, use \\n. enter a line break when setting this variable with setq, use \\n.
To enter a line break in customize, press \\[quoted-insert] C-j." To enter a line break in customize, press \\[quoted-insert] C-j."
:type '(alist :key-type string :value-type string) :type '(alist
:key-type
(choice
(const :tag "Date" "date")
(const :tag "Count" "count")
(const :tag "Authors" "authors")
(const :tag "Subject" "subject")
(const :tag "Tags" "tags")
function)
:value-type (string :tag "Format"))
:group 'notmuch-search) :group 'notmuch-search)
;; The name of this variable `notmuch-init-file' is consistent with the ;; The name of this variable `notmuch-init-file' is consistent with the