mu4e: some doc fixes

This commit is contained in:
djcb
2017-11-04 15:06:45 +02:00
parent f794cea6e7
commit 9ecc610e14
3 changed files with 10 additions and 11 deletions

View File

@ -242,9 +242,10 @@ one of: `:date', `:subject', `:size', `:prio', `:from', `:to.',
'( ("capture message" . mu4e-action-capture-message) '( ("capture message" . mu4e-action-capture-message)
("show this thread" . mu4e-action-show-thread)) ("show this thread" . mu4e-action-show-thread))
"List of actions to perform on messages in the headers list. "List of actions to perform on messages in the headers list.
The actions are of the form (NAME . FUNC) where: The actions are cons-cells of the form (NAME . FUNC) where:
* NAME is the name of the action (e.g. \"Count lines\") * NAME is the name of the action (e.g. \"Count lines\")
* FUNC is a function which receives a message plist as an argument. * FUNC is a function which receives a message plist as an argument.
The first character of NAME is used as the shortcut.") The first character of NAME is used as the shortcut.")
(defvar mu4e-headers-custom-markers (defvar mu4e-headers-custom-markers

View File

@ -351,15 +351,13 @@ or an error."
(if include-related "true" "false"))) (if include-related "true" "false")))
(defun mu4e~proc-move (docid-or-msgid &optional maildir flags) (defun mu4e~proc-move (docid-or-msgid &optional maildir flags)
"Move message identified by DOCID-OR-MSGID. "Move message identified by DOCID-OR-MSGID to optional MAILDIR
At least one of MAILDIR and FLAGS should be specified. Note, even and optionally setting FLAGS. If MAILDIR is nil, message will be
if MAILDIR is nil, this is still a move, since a change in flags moved within the same maildir.
still implies a change in message filename.
MAILDIR (), optionally At least one of MAILDIR and FLAGS must be specified. Note that
setting FLAGS (keyword argument :flags). optionally setting FLAGS even when MAILDIR is nil, this is still a filesystem move, since
in the process. If MAILDIR is nil, message will be moved within the a change in flags implies a change in message filename.
same maildir.
MAILDIR must be a maildir, that is, the part _without_ cur/ or new/ MAILDIR must be a maildir, that is, the part _without_ cur/ or new/
or the root-maildir-prefix. E.g. \"/archive\". This directory must or the root-maildir-prefix. E.g. \"/archive\". This directory must

View File

@ -107,8 +107,8 @@ directory and saves all attachments in the chosen directory."
("view as pdf" . mu4e-action-view-as-pdf) ("view as pdf" . mu4e-action-view-as-pdf)
("show this thread" . mu4e-action-show-thread)) ("show this thread" . mu4e-action-show-thread))
"List of actions to perform on messages in view mode. "List of actions to perform on messages in view mode.
The actions are of the form: The actions are cons-cells of the form:
(NAME FUNC) (NAME . FUNC)
where: where:
* NAME is the name of the action (e.g. \"Count lines\") * NAME is the name of the action (e.g. \"Count lines\")
* FUNC is a function which receives a message plist as an argument. * FUNC is a function which receives a message plist as an argument.