debian/notmuch
1
0
Fork 0
mirror of https://git.notmuchmail.org/git/notmuch synced 2025-02-17 23:53:15 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

emacs: fix some option type declarations

Browse source 
Also improve their doc-strings.
This commit is contained in:
Jonas Bernoulli 2021-07-19 13:31:07 +02:00 • committed by David Bremner
parent f01df47ce1
commit 01298a8437
2 changed files with 45 additions and 30 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

62
emacs/notmuch-tree.el
View file

@ -77,21 +77,28 @@
(defcustom notmuch-tree-result-format (defcustom notmuch-tree-result-format
`(("date" . "%12s ") `(("date" . "%12s ")
("authors" . "%-20s") ("authors" . "%-20s")
((("tree" . "%s")("subject" . "%s")) ." %-54s ") ((("tree" . "%s")
("subject" . "%s"))
. " %-54s ")
("tags" . "(%s)")) ("tags" . "(%s)"))
"Result formatting for tree view. Supported fields are: date, "Result formatting for tree view.
authors, subject, tree, tags. Tree means the thread tree
box graphics. The field may also be a list in which case
the formatting rules are applied recursively and then the
output of all the fields in the list is inserted
according to format-string.
Note the author string should not contain Supported fields are: date, authors, subject, tree, tags.
whitespace (put it in the neighbouring fields instead).
For example: Tree means the thread tree box graphics. The field may
(setq notmuch-tree-result-format \(\(\"authors\" . \"%-40s\"\) also be a list in which case the formatting rules are
\(\"subject\" . \"%s\"\)\)\)" applied recursively and then the output of all the fields
:type '(alist :key-type (string) :value-type (string)) in the list is inserted according to format-string.
Note that the author string should not contain whitespace
\(put it in the neighbouring fields instead). For example:
(setq notmuch-tree-result-format
'((\"authors\" . \"%-40s\")
(\"subject\" . \"%s\")))"
:type '(alist :key-type (choice string
(alist :key-type string
:value-type string))
:value-type string)
:group 'notmuch-tree) :group 'notmuch-tree)
(defcustom notmuch-unthreaded-result-format (defcustom notmuch-unthreaded-result-format
@ -99,19 +106,24 @@ For example:
("authors" . "%-20s") ("authors" . "%-20s")
((("subject" . "%s")) ." %-54s ") ((("subject" . "%s")) ." %-54s ")
("tags" . "(%s)")) ("tags" . "(%s)"))
"Result formatting for unthreaded tree view. Supported fields are: date, "Result formatting for unthreaded tree view.
authors, subject, tree, tags. Tree means the thread tree
box graphics. The field may also be a list in which case
the formatting rules are applied recursively and then the
output of all the fields in the list is inserted
according to format-string.
Note the author string should not contain Supported fields are: date, authors, subject, tree, tags.
whitespace (put it in the neighbouring fields instead).
For example: Tree means the thread tree box graphics. The field may
(setq notmuch-tree-result-format \(\(\"authors\" . \"%-40s\"\) also be a list in which case the formatting rules are
\(\"subject\" . \"%s\"\)\)\)" applied recursively and then the output of all the fields
:type '(alist :key-type (string) :value-type (string)) in the list is inserted according to format-string.
Note that the author string should not contain whitespace
\(put it in the neighbouring fields instead). For example:
(setq notmuch-unthreaded-result-format
'((\"authors\" . \"%-40s\")
(\"subject\" . \"%s\")))"
:type '(alist :key-type (choice string
(alist :key-type string
:value-type string))
:value-type string)
:group 'notmuch-tree) :group 'notmuch-tree)
(defun notmuch-tree-result-format () (defun notmuch-tree-result-format ()

13
emacs/notmuch.el
View file

@ -88,18 +88,21 @@
("authors" . "%-20s ") ("authors" . "%-20s ")
("subject" . "%s ") ("subject" . "%s ")
("tags" . "(%s)")) ("tags" . "(%s)"))
"Search result formatting. Supported fields are: "Search result formatting.
date, count, authors, subject, tags
Supported fields are: date, count, authors, subject, tags.
For example: For example:
(setq notmuch-search-result-format \(\(\"authors\" . \"%-40s\"\) (setq notmuch-search-result-format
\(\"subject\" . \"%s\"\)\)\) '((\"authors\" . \"%-40s\")
(\"subject\" . \"%s\")))
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
\"authors\" field will get elided if the authors list is long; \"authors\" field will get elided if the authors list is long;
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 string :value-type string)
: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