From ec106e38bf505f862edb1a87c2023305ded7b002 Mon Sep 17 00:00:00 2001 From: Jonas Bernoulli Date: Mon, 5 Nov 2012 17:16:46 +0100 Subject: [PATCH] fix defcustom types and improve their doc-strings --- mu4e/mu4e-compose.el | 14 ++++++++------ mu4e/mu4e-mark.el | 16 +++++++++------- mu4e/mu4e-vars.el | 19 +++++++++---------- mu4e/mu4e-view.el | 12 ++++++------ 4 files changed, 32 insertions(+), 29 deletions(-) diff --git a/mu4e/mu4e-compose.el b/mu4e/mu4e-compose.el index b04b52b6..8dfed9e2 100644 --- a/mu4e/mu4e-compose.el +++ b/mu4e/mu4e-compose.el @@ -90,17 +90,19 @@ :group 'mu4e) (defcustom mu4e-sent-messages-behavior 'sent - "Determines what mu4e does with sent messages - this is a symbol -which can be either: + "Determines what mu4e does with sent messages. - * 'sent --> move the sent message to the Sent-folder (`mu4e-sent-folder') - * 'trash --> move the sent message to the Trash-folder (`mu4e-trash-folder') - * 'delete --> delete the sent message. +This is one of the symbols: +* `sent' move the sent message to the Sent-folder (`mu4e-sent-folder') +* `trash' move the sent message to the Trash-folder (`mu4e-trash-folder') +* `delete' delete the sent message. Note, when using GMail/IMAP, you should set this to either 'trash or 'delete, since GMail already takes care of keeping copies in the sent folder." - :type 'symbol + :type '(choice (const sent :tag "move message to mu4e-sent-folder") + (const sent :tag "move message to mu4e-trash-folder") + (const sent :tag "delete message")) :safe 'symbolp :group 'mu4e-compose) diff --git a/mu4e/mu4e-mark.el b/mu4e/mu4e-mark.el index 9a00c376..94d9462d 100644 --- a/mu4e/mu4e-mark.el +++ b/mu4e/mu4e-mark.el @@ -31,13 +31,15 @@ (require 'mu4e-message) (defcustom mu4e-headers-leave-behavior 'ask - "What to do when user leaves the headers view (e.g. quits, - refreshes or does a new search). Value is one of the following - symbols: -- ask (ask the user whether to ignore the marks) -- apply (automatically apply the marks before doing anything else) -- ignore (automatically ignore the marks without asking)." - :type 'symbol + "What to do when user leaves the headers view. +That is when he e.g. quits, refreshes or does a new search. +Value is one of the following symbols: +- `ask' ask user whether to ignore the marks +- `apply' automatically apply the marks before doing anything else +- `ignore' automatically ignore the marks without asking" + :type '(choice (const ask :tag "ask user whether to ignore marks") + (const apply :tag "apply marks without asking") + (const ignore :tag "ignore marks without asking")) :group 'mu4e-headers) (defvar mu4e-headers-show-target t diff --git a/mu4e/mu4e-vars.el b/mu4e/mu4e-vars.el index eb6ddfa5..35fa1f33 100644 --- a/mu4e/mu4e-vars.el +++ b/mu4e/mu4e-vars.el @@ -35,10 +35,9 @@ (defcustom mu4e-mu-home nil "Location of the mu homedir, or nil for the default." - :type 'directory :group 'mu4e :type '(choice (const :tag "Default location" nil) - (const :tag "Specify location" string)) + (directory :tag "Specify location")) :safe 'stringp) (defcustom mu4e-mu-binary (executable-find "mu") @@ -49,15 +48,14 @@ PATH, you can specify the full path." :safe 'stringp) (defcustom mu4e-maildir (expand-file-name "~/Maildir") - "Your Maildir directory; by default, mu4e assumes -~/Maildir." + "Your Maildir directory." :type 'directory :safe 'stringp :group 'mu4e) (defcustom mu4e-get-mail-command "true" - "Shell command to run to retrieve new mail; e.g. 'offlineimap' or -'fetchmail'." + "Shell command to run to retrieve new mail. +Common values are \"offlineimap\" and \"fetchmail\"." :type 'string :group 'mu4e :safe 'stringp) @@ -107,10 +105,11 @@ personal message. This is used when indexing messages." :group 'mu4e) (defcustom mu4e-search-results-limit 500 - "Maximum number of search results (or -1 for unlimited). Since -limiting search results speeds up searches significantly, it's -useful to limit this. Note, to ignore the limit, use a prefix -argument (C-u) before invoking the search." + "Maximum number of search results. +Use -1 for no limit. Since limiting search results speeds up +searches significantly, it's useful to limit this. Note, to +ignore the limit, use a prefix argument (C-u) before invoking the +search." :type '(choice (const :tag "Unlimited" -1) (integer :tag "Limit")) :group 'mu4e) diff --git a/mu4e/mu4e-view.el b/mu4e/mu4e-view.el index 2886d3a9..68d896ee 100644 --- a/mu4e/mu4e-view.el +++ b/mu4e/mu4e-view.el @@ -51,8 +51,8 @@ (defcustom mu4e-view-fields '(:from :to :cc :subject :flags :date :maildir :tags :attachments :signature) - "Header fields to display in the message view buffer. For the -complete list of available headers, see `mu4e-header-info'." + "Header fields to display in the message view buffer. +For the complete list of available headers, see `mu4e-header-info'." :type (list 'symbol) :group 'mu4e-view) @@ -69,14 +69,14 @@ contact." (defcustom mu4e-view-date-format "%c" "Date format to use in the message view, in the format of - `format-time-string'." +`format-time-string'." :type 'string :group 'mu4e-view) (defcustom mu4e-view-image-max-width 800 - "The maximum width for images to display; this is only effective - if you're using an emacs with Imagemagick support, and - `mu4e-show-image' is non-nil." + "The maximum width for images to display. +This is only effective if you're using an emacs with Imagemagick +support, and `mu4e-show-image' is non-nil." :group 'mu4e-view) (defcustom mu4e-view-scroll-to-next t