mirror of
https://git.notmuchmail.org/git/notmuch
synced 2024-12-03 16:14:11 +01:00
emacs: update quoting in docstrings
The complicated looking escapes are needed to avoid compile time warnings. (info "(elisp) Text Quoting Style") for details.
This commit is contained in:
parent
c0880ce750
commit
fc1c81c378
6 changed files with 17 additions and 17 deletions
|
@ -145,7 +145,7 @@ a plist. Supported properties are
|
|||
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
|
||||
specify tree mode, \\='unthreaded to specify
|
||||
unthreaded mode, and set to nil (or anything
|
||||
except tree and unthreaded) to specify search
|
||||
mode.
|
||||
|
|
|
@ -414,9 +414,9 @@ This is similar to `describe-function' for the current major
|
|||
mode, but bindings tables are shown with documentation strings
|
||||
rather than command names. By default, this uses the first line
|
||||
of each command's documentation string. A command can override
|
||||
this by setting the 'notmuch-doc property of its command symbol.
|
||||
this by setting the \\='notmuch-doc property of its command symbol.
|
||||
A command that supports a prefix argument can explicitly document
|
||||
its prefixed behavior by setting the 'notmuch-prefix-doc property
|
||||
its prefixed behavior by setting the \\='notmuch-prefix-doc property
|
||||
of its command symbol."
|
||||
(interactive)
|
||||
(let ((doc (substitute-command-keys
|
||||
|
@ -726,7 +726,7 @@ single element face list."
|
|||
(list face)))
|
||||
|
||||
(defun notmuch-apply-face (object face &optional below start end)
|
||||
"Combine FACE into the 'face text property of OBJECT between START and END.
|
||||
"Combine FACE into the \\='face text property of OBJECT between START and END.
|
||||
|
||||
This function combines FACE with any existing faces between START
|
||||
and END in OBJECT. Attributes specified by FACE take precedence
|
||||
|
|
|
@ -35,7 +35,7 @@ complete S-expression from the input. However, it extends this
|
|||
with an additional function that requires the next value in the
|
||||
input to be a list and descends into it, allowing its elements to
|
||||
be read one at a time or further descended into. Both functions
|
||||
can return 'retry to indicate that not enough input is available.
|
||||
can return \\='retry to indicate that not enough input is available.
|
||||
|
||||
The parser always consumes input from point in the current
|
||||
buffer. Hence, the caller is allowed to delete any data before
|
||||
|
@ -52,10 +52,10 @@ point and may resynchronize after an error by moving point."
|
|||
(defun notmuch-sexp-read (sp)
|
||||
"Consume and return the value at point in the current buffer.
|
||||
|
||||
Returns 'retry if there is insufficient input to parse a complete
|
||||
Returns \\='retry if there is insufficient input to parse a complete
|
||||
value (though it may still move point over whitespace). If the
|
||||
parser is currently inside a list and the next token ends the
|
||||
list, this moves point just past the terminator and returns 'end.
|
||||
list, this moves point just past the terminator and returns \\='end.
|
||||
Otherwise, this moves point to just past the end of the value and
|
||||
returns the value."
|
||||
(skip-chars-forward " \n\r\t")
|
||||
|
@ -125,7 +125,7 @@ returns the value."
|
|||
(defun notmuch-sexp-begin-list (sp)
|
||||
"Parse the beginning of a list value and enter the list.
|
||||
|
||||
Returns 'retry if there is insufficient input to parse the
|
||||
Returns \\='retry if there is insufficient input to parse the
|
||||
beginning of the list. If this is able to parse the beginning of
|
||||
a list, it moves point past the token that opens the list and
|
||||
returns t. Later calls to `notmuch-sexp-read' will return the
|
||||
|
|
|
@ -41,11 +41,11 @@
|
|||
;;; Utility functions
|
||||
|
||||
(defun notmuch-print-run-evince (file)
|
||||
"View FILE using 'evince'."
|
||||
"View FILE using `evince'."
|
||||
(start-process "evince" nil "evince" file))
|
||||
|
||||
(defun notmuch-print-run-muttprint (&optional output)
|
||||
"Pass the contents of the current buffer to 'muttprint'.
|
||||
"Pass the contents of the current buffer to `muttprint'.
|
||||
|
||||
Optional OUTPUT allows passing a list of flags to muttprint."
|
||||
(apply #'notmuch--call-process-region (point-min) (point-max)
|
||||
|
|
|
@ -159,7 +159,7 @@ place of the tag.
|
|||
For example, to replace a tag with another string, simply use
|
||||
that string as a formatting expression. To change the foreground
|
||||
of a tag to red, use the expression
|
||||
(propertize tag 'face '(:foreground \"red\"))
|
||||
(propertize tag \\='face \\='(:foreground \"red\"))
|
||||
|
||||
See also `notmuch-tag-format-image', which can help replace tags
|
||||
with images."
|
||||
|
@ -191,7 +191,7 @@ By default this shows deleted tags with strike-through in red,
|
|||
unless strike-through is not available (e.g., emacs is running in
|
||||
a terminal) in which case it uses inverse video. To hide deleted
|
||||
tags completely set this to
|
||||
'((\".*\" nil))
|
||||
\\='((\".*\" nil))
|
||||
|
||||
See `notmuch-tag-formats' for full documentation."
|
||||
:group 'notmuch-show
|
||||
|
@ -366,9 +366,9 @@ changed (the normal case) are shown using formats from
|
|||
(defcustom notmuch-before-tag-hook nil
|
||||
"Hooks that are run before tags of a message are modified.
|
||||
|
||||
'tag-changes' will contain the tags that are about to be added or removed as
|
||||
`tag-changes' will contain the tags that are about to be added or removed as
|
||||
a list of strings of the form \"+TAG\" or \"-TAG\".
|
||||
'query' will be a string containing the search query that determines
|
||||
`query' will be a string containing the search query that determines
|
||||
the messages that are about to be tagged."
|
||||
:type 'hook
|
||||
:options '(notmuch-hl-line-mode)
|
||||
|
@ -377,9 +377,9 @@ the messages that are about to be tagged."
|
|||
(defcustom notmuch-after-tag-hook nil
|
||||
"Hooks that are run after tags of a message are modified.
|
||||
|
||||
'tag-changes' will contain the tags that were added or removed as
|
||||
`tag-changes' will contain the tags that were added or removed as
|
||||
a list of strings of the form \"+TAG\" or \"-TAG\".
|
||||
'query' will be a string containing the search query that determines
|
||||
`query' will be a string containing the search query that determines
|
||||
the messages that were tagged."
|
||||
:type 'hook
|
||||
:options '(notmuch-hl-line-mode)
|
||||
|
|
|
@ -381,7 +381,7 @@ original filename the sender had."
|
|||
(notmuch-wash-subject-to-filename subject 52)))
|
||||
|
||||
(defun notmuch-wash-convert-inline-patch-to-part (msg depth)
|
||||
"Convert an inline patch into a fake 'text/x-diff' attachment.
|
||||
"Convert an inline patch into a fake `text/x-diff' attachment.
|
||||
|
||||
Given that this function guesses whether a buffer includes a
|
||||
patch and then guesses the extent of the patch, there is scope
|
||||
|
|
Loading…
Reference in a new issue