mirror of
https://git.notmuchmail.org/git/notmuch
synced 2024-11-21 18:38:08 +01:00
emacs: always use elisp quoting style in doc-strings
Emacs doc-strings use neither markdown nor lisp symbol quoting.
This commit is contained in:
parent
3cdf105e0f
commit
d6cacef832
6 changed files with 20 additions and 20 deletions
|
@ -294,7 +294,7 @@ The car is a partial harvest, and the cdr is a full harvest.")
|
|||
"Collect addresses completion candidates.
|
||||
|
||||
It queries the notmuch database for messages sent/received (as
|
||||
configured with `notmuch-address-command`) by the user, collects
|
||||
configured with `notmuch-address-command') by the user, collects
|
||||
destination/source addresses from those messages and stores them
|
||||
in `notmuch-address-completions'.
|
||||
|
||||
|
|
|
@ -101,7 +101,7 @@ Used when a new version is saved, or the message is sent."
|
|||
(notmuch-tag notmuch-draft-id '("+deleted"))))
|
||||
|
||||
(defun notmuch-draft-quote-some-mml ()
|
||||
"Quote the mml tags in `notmuch-draft-quoted-tags`."
|
||||
"Quote the mml tags in `notmuch-draft-quoted-tags'."
|
||||
(save-excursion
|
||||
;; First we deal with any secure tag separately.
|
||||
(message-goto-body)
|
||||
|
@ -122,7 +122,7 @@ Used when a new version is saved, or the message is sent."
|
|||
(insert "!"))))))
|
||||
|
||||
(defun notmuch-draft-unquote-some-mml ()
|
||||
"Unquote the mml tags in `notmuch-draft-quoted-tags`."
|
||||
"Unquote the mml tags in `notmuch-draft-quoted-tags'."
|
||||
(save-excursion
|
||||
(when notmuch-draft-quoted-tags
|
||||
(let ((re (concat "<#!+/?\\("
|
||||
|
@ -174,7 +174,7 @@ Really save and index an unencrypted copy? ")
|
|||
"Save the current draft message in the notmuch database.
|
||||
|
||||
This saves the current message in the database with tags
|
||||
`notmuch-draft-tags` (in addition to any default tags
|
||||
`notmuch-draft-tags' (in addition to any default tags
|
||||
applied to newly inserted messages)."
|
||||
(interactive)
|
||||
(when (notmuch-draft--has-encryption-tag)
|
||||
|
@ -185,7 +185,7 @@ applied to newly inserted messages)."
|
|||
;; so that it is easier to search for the message, and the
|
||||
;; latter so we have a way of accessing the saved message (for
|
||||
;; example to delete it at a later time). We check that the
|
||||
;; user has these in `message-deletable-headers` (the default)
|
||||
;; user has these in `message-deletable-headers' (the default)
|
||||
;; as otherwise they are doing something strange and we
|
||||
;; shouldn't interfere. Note, since we are doing this in a new
|
||||
;; buffer we don't change the version in the compose buffer.
|
||||
|
|
|
@ -138,8 +138,8 @@ a plist. Supported properties are
|
|||
shown. If not present then the :query property
|
||||
is used.
|
||||
:sort-order Specify the sort order to be used for the search.
|
||||
Possible values are 'oldest-first 'newest-first or
|
||||
nil. Nil means use the default sort order.
|
||||
Possible values are `oldest-first', `newest-first'
|
||||
or nil. Nil means use the default sort order.
|
||||
:search-type Specify whether to run the search in search-mode,
|
||||
tree mode or unthreaded mode. Set to 'tree to specify tree
|
||||
mode, 'unthreaded to specify unthreaded mode, and set to nil
|
||||
|
|
|
@ -196,7 +196,7 @@ This is a rearranged version of message mode's message-do-fcc."
|
|||
(defun notmuch-fcc-handler (fcc-header)
|
||||
"Store message with notmuch insert or normal (file) fcc.
|
||||
|
||||
If `notmuch-maildir-use-notmuch-insert` is set then store the
|
||||
If `notmuch-maildir-use-notmuch-insert' is set then store the
|
||||
message using notmuch insert. Otherwise store the message using
|
||||
normal fcc."
|
||||
(message "Doing Fcc...")
|
||||
|
|
|
@ -68,15 +68,15 @@ The key `notmuch-tag-jump-reverse-key' (k by default) should not
|
|||
be used (either as a key, or as the start of a key sequence) as
|
||||
it is already bound: it switches the menu to a menu of the
|
||||
reverse tagging operations. The reverse of a tagging operation is
|
||||
the same list of individual tag-ops but with `+tag` replaced by
|
||||
`-tag` and vice versa.
|
||||
the same list of individual tag-ops but with `+tag' replaced by
|
||||
`-tag' and vice versa.
|
||||
|
||||
If setting this variable outside of customize then it should be a
|
||||
list of triples (lists of three elements). Each triple should be
|
||||
of the form (key-binding tagging-operations name). KEY-BINDING
|
||||
can be a single character or a key sequence; TAGGING-OPERATIONS
|
||||
should either be a list of individual tag operations each of the
|
||||
form `+tag` or `-tag`, or the variable name of a variable that is
|
||||
form `+tag' or `-tag', or the variable name of a variable that is
|
||||
a list of tagging operations; NAME should be a name for the
|
||||
tagging operation, if omitted or empty than then name is taken
|
||||
from TAGGING-OPERATIONS."
|
||||
|
@ -116,7 +116,7 @@ from TAGGING-OPERATIONS."
|
|||
'((t :foreground "red"))
|
||||
"Default face used for the unread tag.
|
||||
|
||||
Used in the default value of `notmuch-tag-formats`."
|
||||
Used in the default value of `notmuch-tag-formats'."
|
||||
:group 'notmuch-faces)
|
||||
|
||||
(defface notmuch-tag-flagged
|
||||
|
@ -128,7 +128,7 @@ Used in the default value of `notmuch-tag-formats`."
|
|||
(:foreground "blue")))
|
||||
"Face used for the flagged tag.
|
||||
|
||||
Used in the default value of `notmuch-tag-formats`."
|
||||
Used in the default value of `notmuch-tag-formats'."
|
||||
:group 'notmuch-faces)
|
||||
|
||||
(defcustom notmuch-tag-formats
|
||||
|
@ -170,7 +170,7 @@ with images."
|
|||
(t :inverse-video t))
|
||||
"Face used to display deleted tags.
|
||||
|
||||
Used in the default value of `notmuch-tag-deleted-formats`."
|
||||
Used in the default value of `notmuch-tag-deleted-formats'."
|
||||
:group 'notmuch-faces)
|
||||
|
||||
(defcustom notmuch-tag-deleted-formats
|
||||
|
@ -178,7 +178,7 @@ Used in the default value of `notmuch-tag-deleted-formats`."
|
|||
(".*" (notmuch-apply-face tag `notmuch-tag-deleted)))
|
||||
"Custom formats for tags when deleted.
|
||||
|
||||
For deleted tags the formats in `notmuch-tag-formats` are applied
|
||||
For deleted tags the formats in `notmuch-tag-formats' are applied
|
||||
first and then these formats are applied on top; that is `tag'
|
||||
passed to the function is the tag with all these previous
|
||||
formattings applied. The formatted can access the original
|
||||
|
@ -199,14 +199,14 @@ See `notmuch-tag-formats' for full documentation."
|
|||
'((t :underline "green"))
|
||||
"Default face used for added tags.
|
||||
|
||||
Used in the default value for `notmuch-tag-added-formats`."
|
||||
Used in the default value for `notmuch-tag-added-formats'."
|
||||
:group 'notmuch-faces)
|
||||
|
||||
(defcustom notmuch-tag-added-formats
|
||||
'((".*" (notmuch-apply-face tag 'notmuch-tag-added)))
|
||||
"Custom formats for tags when added.
|
||||
|
||||
For added tags the formats in `notmuch-tag-formats` are applied
|
||||
For added tags the formats in `notmuch-tag-formats' are applied
|
||||
first and then these formats are applied on top.
|
||||
|
||||
To disable special formatting of added tags, set this variable to
|
||||
|
@ -506,7 +506,7 @@ begin with a \"+\" or a \"-\". If REVERSE is non-nil, replace all
|
|||
Creates and displays a jump menu for the tagging operations
|
||||
specified in `notmuch-tagging-keys'. If REVERSE is set then it
|
||||
offers a menu of the reverses of the operations specified in
|
||||
`notmuch-tagging-keys'; i.e. each `+tag` is replaced by `-tag`
|
||||
`notmuch-tagging-keys'; i.e. each `+tag' is replaced by `-tag'
|
||||
and vice versa."
|
||||
;; In principle this function is simple, but it has to deal with
|
||||
;; lots of cases: different modes (search/show/tree), whether a name
|
||||
|
|
|
@ -342,7 +342,7 @@ there will be called at other points of notmuch execution."
|
|||
"Face used in search mode face for flagged threads.
|
||||
|
||||
This face is the default value for the \"flagged\" tag in
|
||||
`notmuch-search-line-faces`."
|
||||
`notmuch-search-line-faces'."
|
||||
:group 'notmuch-search
|
||||
:group 'notmuch-faces)
|
||||
|
||||
|
@ -352,7 +352,7 @@ This face is the default value for the \"flagged\" tag in
|
|||
"Face used in search mode for unread threads.
|
||||
|
||||
This face is the default value for the \"unread\" tag in
|
||||
`notmuch-search-line-faces`."
|
||||
`notmuch-search-line-faces'."
|
||||
:group 'notmuch-search
|
||||
:group 'notmuch-faces)
|
||||
|
||||
|
|
Loading…
Reference in a new issue