From a1f0c5e9eb54cc21fc850dce8ed119cc58a1e39c Mon Sep 17 00:00:00 2001 From: "Dirk-Jan C. Binnema" Date: Fri, 27 May 2022 21:00:37 +0300 Subject: [PATCH] mu4e: fix emacs-29 bytecompiler warnings Wrong single quotes. --- mu4e/mu4e-actions.el | 2 +- mu4e/mu4e-compose.el | 52 ++++++++++++++++++------------------ mu4e/mu4e-contacts.el | 16 +++++++----- mu4e/mu4e-context.el | 13 ++++----- mu4e/mu4e-draft.el | 19 +++++++------- mu4e/mu4e-folders.el | 12 ++++----- mu4e/mu4e-headers.el | 61 +++++++++++++++++++++++-------------------- mu4e/mu4e-helpers.el | 16 +++++++----- mu4e/mu4e-main.el | 4 +-- mu4e/mu4e-mark.el | 43 +++++++++++++++--------------- mu4e/mu4e-org.el | 7 +++-- mu4e/mu4e-search.el | 10 +++---- mu4e/mu4e-server.el | 26 +++++++++--------- mu4e/mu4e-update.el | 8 +++--- mu4e/mu4e-vars.el | 2 +- mu4e/mu4e-view.el | 10 +++---- mu4e/mu4e.el | 2 +- 17 files changed, 157 insertions(+), 146 deletions(-) diff --git a/mu4e/mu4e-actions.el b/mu4e/mu4e-actions.el index 4632298a..bd43a701 100644 --- a/mu4e/mu4e-actions.el +++ b/mu4e/mu4e-actions.el @@ -184,7 +184,7 @@ receive (:info add :path :docid ) as well as (:update RETAG-ARG is a comma-separated list of additions and removals. Example: +tag,+long tag,-oldtag -would add 'tag' and 'long tag', and remove 'oldtag'." +would add \"tag\" and \"long tag\", and remove \"oldtag\"." (let* ( (path (mu4e-message-field msg :path)) (oldtags (mu4e-message-field msg :tags)) diff --git a/mu4e/mu4e-compose.el b/mu4e/mu4e-compose.el index 79011dac..0e31f2f4 100644 --- a/mu4e/mu4e-compose.el +++ b/mu4e/mu4e-compose.el @@ -236,7 +236,7 @@ Message-ID." (defun mu4e~compose-complete-contact (&optional start) "Complete the text at START with a contact. -Ie. either 'name ' or 'email')." +Ie. either \"name \" or \"email\")." (interactive) (let ((mail-abbrev-mode-regexp mu4e~compose-address-fields-regexp) (eoh ;; end-of-headers @@ -691,24 +691,25 @@ It restores mu4e window layout after killing the compose-buffer." (mu4e~switch-back-to-mu4e-buffer))))) (defun mu4e~compose-set-parent-flag (path) - "Set flags for replied-t and forwarded for the message at PATH. -That is, set the 'replied' \"R\" flag on messages we replied to, -and the 'passed' \"F\" flag on message we have forwarded. + "Set flags for replied-to and forwarded for the message at PATH. +That is, set the `replied' \"R\" flag on messages we replied to, +and the `passed' \"F\" flag on message we have forwarded. -If a message has an 'in-reply-to' header, it is considered a reply -to the message with the corresponding message id. If it does not -have an 'in-reply-to' header, but does have a 'references' header, -it is considered to be a forward message for the message -corresponding with the /last/ message-id in the references header. +If a message has an \"In-Reply-To\" header, it is considered a +reply to the message with the corresponding message id. +Otherwise, if it does not have an \"In-Reply-To\" header, but +does have a \"References:\" header, it is considered to be a +forward message for the message corresponding with the /last/ +message-id in the references header. -Now, if the message has been determined to be either a forwarded +If the message has been determined to be either a forwarded message or a reply, we instruct the server to update that message -with resp. the 'P' (passed) flag for a forwarded message, or the -'R' flag for a replied message. The original messages are also -marked as Seen. +with resp. the \"P\" (passed) flag for a forwarded message, or +the \"R\" flag for a replied message. The original messages are +also marked as Seen. -Function assumes that it's executed in the context of the message -buffer." +Function assumes that it is executed in the context of the +message buffer." (let ((buf (find-file-noselect path))) (when buf (with-current-buffer buf @@ -810,11 +811,11 @@ draft message." _send-actions _return-action) "This is mu4e's implementation of `compose-mail'. Quoting its docstring: -Start composing a mail message to send. -This uses the user’s chosen mail composition package -as selected with the variable ‘mail-user-agent’. -The optional arguments TO and SUBJECT specify recipients -and the initial Subject field, respectively. + +Start composing a mail message to send. This uses the user's +chosen mail composition package as selected with the variable +`mail-user-agent'. The optional arguments TO and SUBJECT specify +recipients and the initial Subject field, respectively. OTHER-HEADERS is an alist specifying additional header fields. Elements look like (HEADER . VALUE) where both @@ -826,11 +827,11 @@ being composed. Interactively, CONTINUE is the prefix argument. SWITCH-FUNCTION, if non-nil, is a function to use to switch to and display the buffer used for mail composition. -YANK-ACTION, if non-nil, is an action to perform, if and when necessary, -to insert the raw text of the message being replied to. -It has the form (FUNCTION . ARGS). The user agent will apply +YANK-ACTION, if non-nil, is an action to perform, if and when +necessary, to insert the raw text of the message being replied +to. It has the form (FUNCTION . ARGS). The user agent will apply FUNCTION to ARGS, to insert the raw text of the original message. -\(The user agent will also run ‘mail-citation-hook’, *after* the +\(The user agent will also run `mail-citation-hook', *after* the original text has been inserted in this way.) SEND-ACTIONS is a list of actions to call when the message is sent. @@ -840,7 +841,8 @@ RETURN-ACTION, if non-nil, is an action for returning to the caller. It has the form (FUNCTION . ARGS). The function is called after the mail has been sent or put aside, and the mail buffer buried." - (unless (mu4e-running-p) + + (unless (mu4e-running-p) (mu4e)) ;; create a new draft message 'resetting' (as below) is not actually needed in diff --git a/mu4e/mu4e-contacts.el b/mu4e/mu4e-contacts.el index a44434e2..d207f339 100644 --- a/mu4e/mu4e-contacts.el +++ b/mu4e/mu4e-contacts.el @@ -37,10 +37,10 @@ :group 'mu4e-compose) (defcustom mu4e-compose-complete-only-personal nil - "Whether to consider only 'personal' e-mail addresses for completion. + "Whether to consider only \"personal\" e-mail addresses for completion. That is, addresses from messages where user was explicitly in one of the address fields (this excludes mailing list messages). -These addresses are the ones specified with `mu init'." +These addresses are the ones specified with \"mu init\"." :type 'boolean :group 'mu4e-compose) @@ -181,11 +181,13 @@ addresses and /regular expressions/." (defun mu4e--rfc822-phrase-type (ph) "Return an atom or quoted-string for the phrase PH. This checks for empty string first. Then quotes around the phrase -\(returning 'rfc822-quoted-string). Then whether there is a quote -inside the phrase (returning 'rfc822-containing-quote). The -reverse of the RFC atext definition is then tested. If it -matches, nil is returned, if not, it is an 'rfc822-atom, which is -returned." +\(returning symbol `rfc822-quoted-string'). Then whether there is +a quote inside the phrase (returning symbol +`rfc822-containing-quote'). + +The reverse of the RFC atext definition is then tested. If it +matches, nil is returned, if not, it returns a symbol +`rfc822-atom'." (cond ((= (length ph) 0) 'rfc822-empty) ((= (aref ph 0) ?\") diff --git a/mu4e/mu4e-context.el b/mu4e/mu4e-context.el index 16af0f34..41fbb33b 100644 --- a/mu4e/mu4e-context.el +++ b/mu4e/mu4e-context.el @@ -177,16 +177,17 @@ or nil if there is no such MSG; similar to what `mu4e-compose-pre-hook' does. POLICY specifies how to do the determination. If POLICY is -'always-ask, we ask the user unconditionally. +`always-ask', we ask the user unconditionally. In all other cases, if any context matches (using its match function), this context is returned. If none of the contexts match, POLICY determines what to do: -- pick-first: pick the first of the contexts available -- ask: ask the user -- ask-if-none: ask if there is no context yet -- otherwise, return nil. Effectively, this leaves the current context as it is." +- `pick-first': pick the first of the contexts available +- `ask': ask the user +- `ask-if-none': ask if there is no context yet +- otherwise, return nil. Effectively, this leaves the current context +as it is." (when mu4e-contexts (if (eq policy 'always-ask) (mu4e--context-ask-user "Select context: ") @@ -232,6 +233,6 @@ global-mode-line." map) (mu4e-context-in-modeline)) -;;; +;;; (provide 'mu4e-context) ;;; mu4e-context.el ends here diff --git a/mu4e/mu4e-draft.el b/mu4e/mu4e-draft.el index 305ff444..5d4c71c7 100644 --- a/mu4e/mu4e-draft.el +++ b/mu4e/mu4e-draft.el @@ -40,8 +40,9 @@ (defcustom mu4e-compose-reply-recipients 'ask "Which recipients to use when replying to a message. -May be 'ask, 'all, 'sender. Note that that only applies to -non-mailing-list message; for those, mu4e always asks." +May be a symbol `ask', `all', `sender'. Note that that only +applies to non-mailing-list message; for those, mu4e always +asks." :type '(choice ask all sender) @@ -106,7 +107,7 @@ symbols, for example: (setq mu4e-sent-messages-behavior (lambda () (if (string= (message-sendmail-envelope-from) \"foo@example.com\") - 'delete 'sent))) + \='delete \='sent))) The various `message-' functions from `message-mode' are available for querying the message information." @@ -208,10 +209,10 @@ the width beyond which format=flowed lines are wrapped." (defcustom mu4e-compose-pre-hook nil "Hook run just *before* message composition starts. -If the compose-type is either 'reply' or 'forward', the variable -`mu4e-compose-parent-message' points to the message replied to / -being forwarded / edited, and `mu4e-compose-type' contains the -type of message to be composed. +If the compose-type is a symbol, either `reply' or `forward', the +variable `mu4e-compose-parent-message' points to the message +replied to / being forwarded / edited, and `mu4e-compose-type' +contains the type of message to be composed. Note that there is no draft message yet when this hook runs, it is meant for influencing the how mu4e constructs the draft @@ -222,8 +223,8 @@ place to do that." :group 'mu4e-compose) (defcustom mu4e-compose-dont-reply-to-self nil - "If non-nil, don't include self. -(as decided by `mu4e-personal-address-p')" + "If non-nil, do not include self. +Selfness is decided by `mu4e-personal-address-p'" :type 'boolean :group 'mu4e-compose) diff --git a/mu4e/mu4e-folders.el b/mu4e/mu4e-folders.el index 14fccc78..a01e17e4 100644 --- a/mu4e/mu4e-folders.el +++ b/mu4e/mu4e-folders.el @@ -109,8 +109,8 @@ For backward compatibility, an older form is recognized as well: \"/archive/\"), and key is a single character. You can use these shortcuts in the headers and view buffers, for -example with `mu4e-mark-for-move-quick' (or 'm', by default) or -`mu4e-jump-to-maildir' (or 'j', by default), followed by the +example with `mu4e-mark-for-move-quick' (or \"m\", by default) or +`mu4e-jump-to-maildir' (or \"j\", by default), followed by the designated shortcut character for the maildir. Unlike in search queries, folder names with spaces in them must @@ -277,10 +277,10 @@ the list of maildirs will not change until you restart mu4e." (defun mu4e-ask-maildir (prompt) "Ask the user for a shortcut (using PROMPT). -As per (mu4e-maildir-shortcuts), then return the corresponding folder -name. If the special shortcut 'o' (for _o_ther) is used, or if -`(mu4e-maildir-shortcuts)' evaluates to nil, let user choose from -all maildirs under `mu4e-maildir'." +As per (mu4e-maildir-shortcuts), then return the corresponding +folder name. If the special shortcut \"o\" (for _o_ther) is used, +or if (mu4e-maildir-shortcuts) evaluates to nil, let user choose +from all maildirs under `mu4e-maildir'." (let ((prompt (mu4e-format "%s" prompt))) (if (not (mu4e-maildir-shortcuts)) (substring-no-properties diff --git a/mu4e/mu4e-headers.el b/mu4e/mu4e-headers.el index 65b4da5f..b59d47df 100644 --- a/mu4e/mu4e-headers.el +++ b/mu4e/mu4e-headers.el @@ -70,11 +70,13 @@ "A list of header fields to show in the headers buffer. Each element has the form (HEADER . WIDTH), where HEADER is one of the available headers (see `mu4e-header-info') and WIDTH is the -respective width in characters. A width of `nil' means -'unrestricted', and this is best reserved for the rightmost (last) -field. Note that emacs may become very slow with excessively long -lines (1000s of characters), so if you regularly get such messages, -you want to avoid fields with `nil' altogether." +respective width in characters. + +A width of nil means \"unrestricted\", and this is best reserved +for the rightmost (last) field. Note that emacs may become very +slow with excessively long lines (1000s of characters), so if you +regularly get such messages, you want to avoid fields with nil +altogether." :type `(repeat (cons (choice ,@(mapcar (lambda (h) (list 'const :tag (plist-get (cdr h) :help) @@ -138,17 +140,17 @@ next mail after marking a message in header view." (defvar mu4e-headers-hide-predicate nil - "Predicate function applied to headers before they are shown; -if function is nil or evaluates to nil, show the header, -otherwise don't. function takes one parameter MSG, which is the -message plist for the message to be hidden or not. + "Predicate function to hide matching heasders. +If the function evaluates to non-nil when applied a a message +plist, do not show the corresponding header. The function takes +one parameter MSG, which is the message plist for the message to +be hidden or not. + +Example that hides all trashed messages: -Example that hides all 'trashed' messages: (setq mu4e-headers-hide-predicate (lambda (msg) - (member 'trashed (mu4e-message-field msg :flags)))) - -Note that this is merely a display filter.") + (member \='trashed (mu4e-message-field msg :flags)))).") (defcustom mu4e-headers-visible-flags '(draft flagged new passed replied trashed attach encrypted signed list personal) @@ -507,10 +509,10 @@ while our display may be different)." (defun mu4e~headers-from-or-to (msg) "Get the From: address from MSG if not one of user's; otherwise get To:. -When the from address for message MSG is one of the the user's addresses, -\(as per `mu4e-personal-address-p'), show the To address; -otherwise ; show the from address; prefixed with the appropriate -`mu4e-headers-from-or-to-prefix'." +When the from address for message MSG is one of the the user's +addresses, (as per `mu4e-personal-address-p'), show the To +address. Otherwise, show the From address, prefixed with the +appropriate `mu4e-headers-from-or-to-prefix'." (let* ((from1 (car-safe (mu4e-message-field msg :from))) (from1-addr (and from1 (mu4e-contact-email from1))) (is-user (and from1-addr (mu4e-personal-address-p from1-addr)))) @@ -520,12 +522,11 @@ otherwise ; show the from address; prefixed with the appropriate (concat (car mu4e-headers-from-or-to-prefix) (mu4e~headers-contact-str (mu4e-message-field msg :from)))))) - (defun mu4e~headers-human-date (msg) - "Show a 'human' date. -If the date is today, show the time, otherwise, show the -date. The formats used for date and time are -`mu4e-headers-date-format' and `mu4e-headers-time-format'." + "Show a \"human\" date for MSG. +If the date is today, show the time, otherwise, show the date. +The formats used for date and time are `mu4e-headers-date-format' +and `mu4e-headers-time-format'." (let ((date (mu4e-msg-field msg :date))) (if (equal date '(0 0 0)) "None" @@ -539,9 +540,10 @@ date. The formats used for date and time are (format-time-string mu4e-headers-date-format date)))))) (defun mu4e~headers-thread-subject (msg) - "Get the subject if it is the first one in a thread; otherwise, -return the thread-prefix without the subject-text. In other words, -show the subject of a thread only once, similar to e.g. 'mutt'." + "Get the subject for MSG if it is the first one in a thread. +Otherwise, return the thread-prefix without the subject-text. In +other words, show the subject of a thread only once, similar to +e.g. \"mutt\"." (let* ((tinfo (mu4e-message-field msg :meta)) (subj (mu4e-msg-field msg :subject))) (concat ;; prefix subject with a thread indicator @@ -602,7 +604,7 @@ found." (defun mu4e~headers-truncate-field-precise (field val width) "Return VAL truncated to one less than WIDTH, with a trailing -space propertized with a 'display text property which expands to +space propertized with a `display' text property which expands to the correct column for display." (when width (let ((end-col (cl-loop for (f . w) in mu4e-headers-fields @@ -1498,9 +1500,10 @@ descendants." ;;; Interactive functions (defun mu4e-headers-change-sorting (&optional field dir) "Change the sorting/threading parameters. -FIELD is the field to sort by; DIR is a symbol: either 'ascending, -'descending, 't (meaning: if FIELD is the same as the current -sortfield, change the sort-order) or nil (ask the user)." +FIELD is the field to sort by; DIR is a symbol: either +`ascending', `descending', t (meaning: if FIELD is the same as +the current sortfield, change the sort-order) or nil (ask the +user)." (interactive) (let* ((field (or field diff --git a/mu4e/mu4e-helpers.el b/mu4e/mu4e-helpers.el index e49d12d0..da1dec68 100644 --- a/mu4e/mu4e-helpers.el +++ b/mu4e/mu4e-helpers.el @@ -71,7 +71,7 @@ You can customize the exact fancy characters used with ;; here because they're needed in multiple buffers. (defcustom mu4e-view-auto-mark-as-read t - "Automatically mark messages are 'read' when you read them. + "Automatically mark messages as read when you read them. This is the default behavior, but can be turned off, for example when using a read-only file-system. @@ -226,8 +226,8 @@ trying an exact match." (defun mu4e-read-option (prompt options) "Ask user for an option from a list on the input area. -PROMPT describes a multiple-choice question to the user. -OPTIONS describe the options, and is a list of cells describing +PROMPT describes a multiple-choice question to the user. OPTIONS +describe the options, and is a list of cells describing particular options. Cells have the following structure: (OPTIONSTRING . RESULT) @@ -240,12 +240,12 @@ can prefix the string with an uniquifying character. The options are provided as a list for the user to choose from; user can then choose by typing CHAR. Example: (mu4e-read-option \"Choose an animal: \" - '((\"Monkey\" . monkey) (\"Gnu\" . gnu) (\"xMoose\" . moose))) + \='((\"Monkey\" . monkey) (\"Gnu\" . gnu) (\"xMoose\" . moose))) User now will be presented with a list: \"Choose an animal: [M]onkey, [G]nu, [x]Moose\". -Function will return the cdr of the list element." +Function returns the cdr of the list element." (let* ((prompt (mu4e-format "%s" prompt)) (optionsstr (mapconcat @@ -345,8 +345,10 @@ The results are a list of elements of the form (defun mu4e-log (type frm &rest args) "Log a message of TYPE with format-string FRM and ARGS. Use the mu4e log buffer for this. If the variable mu4e-debug is -non-nil. Type is either 'to-server, 'from-server or 'misc. This -function is meant for debugging." +non-nil. Type is a symbol, either `to-server', `from-server' or +`misc'. + +This function is meant for debugging." (when mu4e-debug (with-current-buffer (mu4e--get-log-buffer) (let* ((inhibit-read-only t) diff --git a/mu4e/mu4e-main.el b/mu4e/mu4e-main.el index 1b203b3e..72ac3dab 100644 --- a/mu4e/mu4e-main.el +++ b/mu4e/mu4e-main.el @@ -77,12 +77,12 @@ the personal addresses.") (switch-to-buffer ,curbuf))))) (defun mu4e-about () - "Show the mu4e 'about' page." + "Show the mu4e \"About\" page." (interactive) (mu4e-info (concat mu4e-doc-dir "/mu4e-about.org"))) (defun mu4e-news () - "Show the mu4e 'about' page." + "Show page with news for the current version of mu4e." (interactive) (mu4e-info (concat mu4e-doc-dir "/NEWS.org"))) diff --git a/mu4e/mu4e-mark.el b/mu4e/mu4e-mark.el index cff5ffdc..e575ea46 100644 --- a/mu4e/mu4e-mark.el +++ b/mu4e/mu4e-mark.el @@ -58,21 +58,21 @@ executed and the message itself." :group 'mu4e-headers) (defvar mu4e-headers-show-target t - "Whether to show targets (such as '-> delete', '-> /archive') -when marking message. Normally, this is useful information for the -user, however, when you often mark large numbers (thousands) of -message, showing the target makes this quite a bit slower (showing -the target uses an Emacs feature called 'overlays', which aren't -particularly fast).") + "Whether to show targets (such as \"-> delete\", \"-> /archive\") +when marking message. Normally, this is useful information for +the user, however, when you often mark large numbers (thousands) +of message, showing the target makes this quite a bit +slower (showing the target uses Emacs overlays, which can be slow +when overused).") ;;; Insert stuff (defvar mu4e--mark-map nil "Contains a mapping of docid->markinfo. When a message is marked, the information is added here. markinfo -is a cons cell consisting of the following: \(mark . target) -where MARK is the type of mark (move, trash, delete) -TARGET (optional) is the target directory (for 'move')") +is a cons cell consisting of the following: (mark . target) where +MARK is the type of mark (move, trash, delete) TARGET (optional) +is the target directory (for \"move\")") ;; the mark-map is specific for the current header buffer ;; currently, there can't be more than one, but we never know what will @@ -218,9 +218,9 @@ properties are: (defun mu4e-mark-at-point (mark target) "Mark (or unmark) message at point. MARK specifies the mark-type. For `move'-marks and `trash'-marks -the TARGET argument is non-nil and specifies to which -maildir the message is to be moved/trashed. The function works in -both headers buffers and message buffers. +the TARGET argument is non-nil and specifies to which maildir the +message is to be moved/trashed. The function works in both +headers buffers and message buffers. The following marks are available, and the corresponding props: @@ -234,16 +234,16 @@ The following marks are available, and the corresponding props: `read' n mark the message as read `trash' y trash the message to some folder `unflag' n mark this message for unflagging - `untrash' n remove the 'trashed' flag from a message + `untrash' n remove the `trashed' flag from a message `unmark' n unmark this message `unread' n mark the message as unread `action' y mark the message for some action." (interactive) (let* ((msg (mu4e-message-at-point)) (docid (mu4e-message-field msg :docid)) - ;; get a cell with the mark char and the 'target' 'move' already has a - ;; target (the target folder) the other ones get a pseudo "target", as - ;; info for the user. + ;; get a cell with the mark char and the "move" already has a target + ;; (the target folder) the other ones get a pseudo "target", as info + ;; for the user. (markdesc (cdr (or (assq mark mu4e-marks) (mu4e-error "Invalid mark %S" mark)))) (get-markkar @@ -340,7 +340,7 @@ Optionally, provide TARGET (for moves)." (defun mu4e--mark-get-markpair (prompt &optional allow-something) "Ask user with PROMPT for a mark and return (MARK . TARGET). -If ALLOW-SOMETHING is non-nil, allow the 'something' pseudo mark +If ALLOW-SOMETHING is non-nil, allow the `something' pseudo mark as well." (let* ((marks (mapcar (lambda (markdescr) (cons (plist-get (cdr markdescr) :prompt) @@ -447,10 +447,11 @@ If NO-CONFIRMATION is non-nil, don't ask user for confirmation." (defun mu4e-mark-handle-when-leaving () "Handle any mark-instances in the current buffer when leaving. -This is done according to the value of `mu4e-headers-leave-behavior'. This -function is to be called before any further action (like searching, -quitting the buffer) is taken; returning t means 'take the following -action', return nil means 'don't do anything'." +This is done according to the value of +`mu4e-headers-leave-behavior'. This function is to be called +before any further action (like searching, quitting the buffer) +is taken; returning t means \"take the following action\", return +nil means \"don't do anything\"." (mu4e--mark-in-context (let ((marknum (mu4e-mark-marks-num)) (what mu4e-headers-leave-behavior)) diff --git a/mu4e/mu4e-org.el b/mu4e/mu4e-org.el index a3319661..f3fc0901 100644 --- a/mu4e/mu4e-org.el +++ b/mu4e/mu4e-org.el @@ -52,7 +52,7 @@ Example usage: \"No date\"))) (concat subject \" \" date))) - (setq org-mu4e-link-desc-func 'my-link-descr)" + (setq org-mu4e-link-desc-func \='my-link-descr)" :type '(function) :group 'mu4e-org) @@ -95,7 +95,6 @@ the current query; otherwise, it links to the message at point.") (mu4e-contact-email to)) ;; mu4e-specific :link ,(concat "mu4e:msgid:" msgid) :description ,(funcall mu4e-org-link-desc-func msg)))) - (message "PROPS %S" props) (apply #'org-store-link-props props))) (defun mu4e-org-store-link () @@ -113,8 +112,8 @@ valid even after moving the message around." (defun mu4e-org-open (link) "Open the org LINK. -Open the mu4e message (for links starting with 'msgid:') or run -the query (for links starting with 'query:')." +Open the mu4e message (for links starting with \"msgid:\") or run +the query (for links starting with \"query:\")." (require 'mu4e) (cond ((string-match "^msgid:\\(.+\\)" link) diff --git a/mu4e/mu4e-search.el b/mu4e/mu4e-search.el index b7c78a6a..20f98d1c 100644 --- a/mu4e/mu4e-search.el +++ b/mu4e/mu4e-search.el @@ -197,8 +197,8 @@ the search." (defun mu4e-search-narrow(&optional filter) "Narrow the last search. Do so by appending search expression FILTER to the last search -expression. Note that you can go back to previous -query (effectively, 'widen' it), with `mu4e-search-prev'." +expression. Note that you can go back to the previous +query (effectively, \"widen\" it), with `mu4e-search-prev'." (interactive (let ((filter (read-string (mu4e-format "Narrow down to: ") @@ -292,8 +292,8 @@ query (effectively, 'widen' it), with `mu4e-search-prev'." (defun mu4e--search-push-query (query where) "Push QUERY to one of the query stacks. WHERE is a symbol telling us where to push; it's a symbol, either -'future or 'past. Functional also removes duplicates, limits the -stack size." +`future' or `past'. Also removes duplicates and truncates to +limit the stack size." (let ((stack (pcase where ('past mu4e--search-query-past) @@ -406,7 +406,7 @@ either `future' or `past'." (defun mu4e--search-completion-contacts-action (match _status) "Delete contact alias from contact autocompletion, leaving just email address. -Implements 'completion-extra-properties' :exit-function which +Implements the `completion-extra-properties' :exit-function' which requires a function with arguments string MATCH and completion status, STATUS." (let ((contact-email (replace-regexp-in-string "^.*<\\|>$" "" match))) diff --git a/mu4e/mu4e-server.el b/mu4e/mu4e-server.el index 9f0f6d11..3ebec34a 100644 --- a/mu4e/mu4e-server.el +++ b/mu4e/mu4e-server.el @@ -205,9 +205,8 @@ removed." (defun mu4e--server-filter (_proc str) "Filter string STR from PROC. -This processes the 'mu server' output. It accumulates the -strings into valid sexps by checking of the ';;eox' `end-of-sexp' -marker, and then evaluating them. +This processes the \"mu server\" output. It accumulates the +strings into valid sexpsv and evaluating those. The server output is as follows: @@ -460,11 +459,12 @@ get at most MAX contacts." (defun mu4e--server-find (query threads sortfield sortdir maxnum skip-dups include-related) "Run QUERY with THREADS SORTFIELD SORTDIR MAXNUM SKIP-DUPS INCLUDE-RELATED. -If THREADS is non-nil, show results in threaded fashion, SORTFIELD -is a symbol describing the field to sort by (or nil); see -`mu4e~headers-sortfield-choices'. If SORT is `descending', sort -Z->A, if it's `ascending', sort A->Z. MAXNUM determines the -maximum number of results to return, or nil for 'unlimited'. If + +If THREADS is non-nil, show results in threaded fashion, +SORTFIELD is a symbol describing the field to sort by (or nil); +see `mu4e~headers-sortfield-choices'. If SORT is `descending', +sort Z->A, if it's `ascending', sort A->Z. MAXNUM determines the +maximum number of results to return, or nil for unlimited. If SKIP-DUPS is non-nil, show only one of duplicate messages (see `mu4e-headers-skip-duplicates'). If INCLUDE-RELATED is non-nil, include messages related to the messages matching the search @@ -472,7 +472,7 @@ query (see `mu4e-headers-include-related'). For each result found, a function is called, depending on the kind of result. The variables `mu4e-error-func' contain the -function that will be called for, resp., a message (header row) +function that to be be called for, resp., a message (header) or an error." (mu4e--server-call-mu `(find @@ -506,7 +506,7 @@ or the root-maildir-prefix. E.g. \"/archive\". This directory must already exist. The FLAGS parameter can have the following forms: - 1. a list of flags such as '(passed replied seen) + 1. a list of flags such as `(passed replied seen)' 2. a string containing the one-char versions of the flags, e.g. \"PRS\" 3. a delta-string specifying the changes with +/- and the one-char flags, e.g. \"+S-N\" to set Seen and remove New. @@ -521,7 +521,7 @@ If the variable `mu4e-change-filenames-when-moving' is non-nil, moving to a different maildir generates new names forq the target files; this helps certain tools (such as mbsync). -If NO-VIEW is non-nil, don't update the view. +If NO-VIEW is non-nil, do not update the view. Returns either (:update ... ) or (:error ) sexp, which are handled my `mu4e-update-func' and `mu4e-error-func', respectively." @@ -541,8 +541,8 @@ Returns either (:update ... ) or (:error ) sexp, which are handled my (defun mu4e--server-ping (&optional queries) "Sends a ping to the mu server, expecting a (:pong ...) in response. -QUERIES is a list of queries for the number of results with read/unread status -are returned in the 'pong' response." +QUERIES is a list of queries for the number of results with +read/unread status are returned in the pong-response." (mu4e--server-call-mu `(ping :queries ,queries))) (defun mu4e--server-remove (docid) diff --git a/mu4e/mu4e-update.el b/mu4e/mu4e-update.el index bdebf437..b261d895 100644 --- a/mu4e/mu4e-update.el +++ b/mu4e/mu4e-update.el @@ -38,9 +38,9 @@ Common values are \"offlineimap\", \"fetchmail\" or \"mbsync\", but arbitrary shell-commands can be used. When set to the literal string \"true\" (the default), the -command simply finishes successfully (running the 'true' command) -without retrieving any mail. This can be useful when mail is -already retrieved in another way, such as a local MDA." +command simply finishes successfully (running the \"true\" +command) without retrieving any mail. This can be useful when +mail is already retrieved in another way, such as a local MDA." :type 'string :group 'mu4e :safe 'stringp) @@ -77,7 +77,7 @@ shown but can slow with large message stores on slow file-systems." :safe 'booleanp) (defcustom mu4e-index-lazy-check nil - "Whether to only use a 'lazy check' during reindexing. + "Whether to only use a \"lazy\" check during reindexing. This influences how we decide whether a message needs (re)indexing or not. diff --git a/mu4e/mu4e-vars.el b/mu4e/mu4e-vars.el index d4f3b80c..f8fa7769 100644 --- a/mu4e/mu4e-vars.el +++ b/mu4e/mu4e-vars.el @@ -34,7 +34,7 @@ :group 'mail) (defcustom mu4e-headers-include-related t - "Wether to include 'related' messages in queries. + "Wether to include \"related\" messages in queries. With this option set to non-nil, not just return the matches for a searches, but also messages that are related (through their references) to these messages. This can be useful e.g. to include diff --git a/mu4e/mu4e-view.el b/mu4e/mu4e-view.el index bd376775..2b309b4b 100644 --- a/mu4e/mu4e-view.el +++ b/mu4e/mu4e-view.el @@ -637,11 +637,11 @@ message." (defun mu4e-view (msg) "Display the message MSG in a new buffer, and keep in sync with HDRSBUF. -'In sync' here means that moving to the next/previous message in -the the message view affects HDRSBUF, as does marking etc. +\"In sync\" here means that moving to the next/previous message +in the the message view affects HDRSBUF, as does marking etc. -As a side-effect, a message that is being viewed loses its 'unread' -marking if it still had that." +As a side-effect, a message that is being viewed loses its +`unread' marking if it still had that." (mu4e~headers-update-handler msg nil nil) ;; update headers, if necessary. @@ -1065,7 +1065,7 @@ Based on Gnus' article-mode." ("ytoggle crypto" . gnus-article-hide-pem) ("ftoggle fill-flowed" . mu4e-view-toggle-fill-flowed) ("mtoggle show all MIME parts" . mu4e-view-toggle-show-mime-parts)) -"Various options for 'massaging' the message view. See `(gnus) +"Various options for \"massaging\" the message view. See `(gnus) Article Treatment' for more options." :group 'mu4e-view :type '(alist :key-type string :value-type function)) diff --git a/mu4e/mu4e.el b/mu4e/mu4e.el index c55f1bea..caceddc7 100644 --- a/mu4e/mu4e.el +++ b/mu4e/mu4e.el @@ -111,7 +111,7 @@ is non-nil." ;;; Starting / getting mail / updating the index (defun mu4e--pong-handler (_data func) - "Handle 'pong' responses from the mu server. + "Handle \"pong\" responses from the mu server. Invoke FUNC if non-nil." (let ((doccount (plist-get (mu4e-server-properties) :doccount))) (mu4e--check-requirements)