mu4e-folder: improve mu4e-maildir-shortcuts docstring

This commit is contained in:
Dirk-Jan C. Binnema
2025-04-15 21:26:21 +03:00
parent 97a6bab35c
commit 635f6f1bc2

View File

@ -94,20 +94,22 @@ nil otherwise."
(defcustom mu4e-maildir-shortcuts nil (defcustom mu4e-maildir-shortcuts nil
"A list of maildir shortcuts. "A list of maildir shortcuts.
This makes it possible to quickly go to a particular
maildir (folder), or quickly moving messages to them (e.g., for
archiving or refiling).
The format is the same as for `mu4e-bookmarks', with a few Creating a shortcut makes it possible to quickly go to a
difference, so see its doc-strings for further details. particular maildir (folder), or quickly moving messages to
them (e.g., for archiving or refiling).
The only field specific for `mu4e-maildir-shortcuts' is The format is mostly the same as for `mu4e-bookmarks', with a few
- `:maildir' - the maildir for the shortcut (e.g., \"/archive\") difference, so see its doc-string for further details.
The only field specific to `mu4e-maildir-shortcuts' is
`:maildir', which is the property specifying the maildir for the
shortcut (e.g., \"/archive\").
Example: Example:
\\(setq mu4e-maildir-shortcuts (setq mu4e-maildir-shortcuts
\\'( (:maildir \"/inbox\" :key ?i :hide-if-no-unread t) '((:maildir \"/inbox\" :key ?i :hide-if-no-unread t)
(:maildir \"/drafts\" :key ?d :hide t) (:maildir \"/drafts\" :key ?d :hide t)
(:maildir \"/sent\" :key ?s :hide-unread t))) (:maildir \"/sent\" :key ?s :hide-unread t)))
@ -164,7 +166,6 @@ mime-type are nil."
(defvar mu4e-maildir-list nil (defvar mu4e-maildir-list nil
"Cached list of maildirs.") "Cached list of maildirs.")
(defun mu4e-maildir-shortcuts () (defun mu4e-maildir-shortcuts ()
"Get `mu4e-maildir-shortcuts' in the (new) format. "Get `mu4e-maildir-shortcuts' in the (new) format.
Converts from the old format if needed." Converts from the old format if needed."