Merge pull request #1039 from ian-kelling/docs-mu4e-get-maildirs

mu4e: improve `mu4e-get-maildirs' docstring
This commit is contained in:
Dirk-Jan C. Binnema
2017-03-05 15:53:19 +02:00
committed by GitHub

View File

@ -345,7 +345,8 @@ cache the next time `mu4e-get-maildirs' gets called.")
(defun mu4e-get-maildirs ()
"Get maildirs under `mu4e-maildir', recursively, as a list of
relative paths (ie., /archive, /sent etc.). Most of the work is
done in `mu4e-get-maildirs-1'. Note, these results are /cached/, so
done in `mu4e~get-maildirs-1'. Note, these results are /cached/
if `mu4e-cache-maildir-list' is customized to non-nil. In that case,
the list of maildirs will not change until you restart mu4e."
(unless mu4e-maildir (mu4e-error "`mu4e-maildir' is not defined"))
(unless (and mu4e-maildir-list mu4e-cache-maildir-list)