mirror of
https://git.notmuchmail.org/git/notmuch
synced 2024-12-22 09:24:54 +01:00
emacs: fix some option type declarations
Also improve their doc-strings.
This commit is contained in:
parent
f01df47ce1
commit
01298a8437
2 changed files with 45 additions and 30 deletions
|
@ -77,21 +77,28 @@
|
|||
(defcustom notmuch-tree-result-format
|
||||
`(("date" . "%12s ")
|
||||
("authors" . "%-20s")
|
||||
((("tree" . "%s")("subject" . "%s")) ." %-54s ")
|
||||
((("tree" . "%s")
|
||||
("subject" . "%s"))
|
||||
. " %-54s ")
|
||||
("tags" . "(%s)"))
|
||||
"Result formatting for tree view. Supported fields are: date,
|
||||
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.
|
||||
"Result formatting for tree view.
|
||||
|
||||
Note 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 (string) :value-type (string))
|
||||
Supported fields are: date, 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 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)
|
||||
|
||||
(defcustom notmuch-unthreaded-result-format
|
||||
|
@ -99,19 +106,24 @@ For example:
|
|||
("authors" . "%-20s")
|
||||
((("subject" . "%s")) ." %-54s ")
|
||||
("tags" . "(%s)"))
|
||||
"Result formatting for unthreaded tree view. Supported fields are: date,
|
||||
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.
|
||||
"Result formatting for unthreaded tree view.
|
||||
|
||||
Note 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 (string) :value-type (string))
|
||||
Supported fields are: date, 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 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)
|
||||
|
||||
(defun notmuch-tree-result-format ()
|
||||
|
|
|
@ -88,18 +88,21 @@
|
|||
("authors" . "%-20s ")
|
||||
("subject" . "%s ")
|
||||
("tags" . "(%s)"))
|
||||
"Search result formatting. Supported fields are:
|
||||
date, count, authors, subject, tags
|
||||
"Search result formatting.
|
||||
|
||||
Supported fields are: date, count, authors, subject, tags.
|
||||
For example:
|
||||
(setq notmuch-search-result-format \(\(\"authors\" . \"%-40s\"\)
|
||||
\(\"subject\" . \"%s\"\)\)\)
|
||||
(setq notmuch-search-result-format
|
||||
'((\"authors\" . \"%-40s\")
|
||||
(\"subject\" . \"%s\")))
|
||||
|
||||
Line breaks are permitted in format strings (though this is
|
||||
currently experimental). Note that a line break at the end of an
|
||||
\"authors\" field will get elided if the authors list is long;
|
||||
place it instead at the beginning of the following field. To
|
||||
enter a line break when setting this variable with setq, use \\n.
|
||||
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)
|
||||
|
||||
;; The name of this variable `notmuch-init-file' is consistent with the
|
||||
|
|
Loading…
Reference in a new issue