From 9ecc610e141bde6fcf0961715fabfe71f2ad80aa Mon Sep 17 00:00:00 2001 From: djcb Date: Sat, 4 Nov 2017 15:06:45 +0200 Subject: [PATCH] mu4e: some doc fixes --- mu4e/mu4e-headers.el | 3 ++- mu4e/mu4e-proc.el | 14 ++++++-------- mu4e/mu4e-view.el | 4 ++-- 3 files changed, 10 insertions(+), 11 deletions(-) diff --git a/mu4e/mu4e-headers.el b/mu4e/mu4e-headers.el index 77b95ad9..851a602a 100644 --- a/mu4e/mu4e-headers.el +++ b/mu4e/mu4e-headers.el @@ -242,9 +242,10 @@ one of: `:date', `:subject', `:size', `:prio', `:from', `:to.', '( ("capture message" . mu4e-action-capture-message) ("show this thread" . mu4e-action-show-thread)) "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\") * FUNC is a function which receives a message plist as an argument. + The first character of NAME is used as the shortcut.") (defvar mu4e-headers-custom-markers diff --git a/mu4e/mu4e-proc.el b/mu4e/mu4e-proc.el index eb5efe95..8e1494dc 100644 --- a/mu4e/mu4e-proc.el +++ b/mu4e/mu4e-proc.el @@ -351,15 +351,13 @@ or an error." (if include-related "true" "false"))) (defun mu4e~proc-move (docid-or-msgid &optional maildir flags) - "Move message identified by DOCID-OR-MSGID. -At least one of MAILDIR and FLAGS should be specified. Note, even -if MAILDIR is nil, this is still a move, since a change in flags -still implies a change in message filename. + "Move message identified by DOCID-OR-MSGID to optional MAILDIR +and optionally setting FLAGS. If MAILDIR is nil, message will be +moved within the same maildir. -MAILDIR (), optionally -setting FLAGS (keyword argument :flags). optionally setting FLAGS -in the process. If MAILDIR is nil, message will be moved within the -same maildir. +At least one of MAILDIR and FLAGS must be specified. Note that +even when MAILDIR is nil, this is still a filesystem move, since +a change in flags implies a change in message filename. MAILDIR must be a maildir, that is, the part _without_ cur/ or new/ or the root-maildir-prefix. E.g. \"/archive\". This directory must diff --git a/mu4e/mu4e-view.el b/mu4e/mu4e-view.el index 72dcf566..6a85e45d 100644 --- a/mu4e/mu4e-view.el +++ b/mu4e/mu4e-view.el @@ -107,8 +107,8 @@ directory and saves all attachments in the chosen directory." ("view as pdf" . mu4e-action-view-as-pdf) ("show this thread" . mu4e-action-show-thread)) "List of actions to perform on messages in view mode. -The actions are of the form: - (NAME FUNC) +The actions are cons-cells of the form: + (NAME . FUNC) where: * NAME is the name of the action (e.g. \"Count lines\") * FUNC is a function which receives a message plist as an argument.