From 2a6100b64dea45b4a72f4443f8fd49db523f35ce Mon Sep 17 00:00:00 2001 From: Paul Eggert Date: Wed, 2 Sep 2015 05:29:33 +0000 Subject: [PATCH] Escape ` and ' in doc MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit * gnus-art.el (gnus-article-address-banner-alist) (gnus-face-properties-alist): * gnus-sum.el (gnus-newsgroup-variables): * nndiary.el (nndiary-reminders): * nnmail.el (nnmail-fancy-expiry-targets, nnmail-split-fancy): Escape apostrophes and grave accents in docstrings if they are supposed to stand for themselves and are not quotes. Remove apostrophes from docstring examples like ‘'(calendar-nth-named-day -1 0 10 year)’ that confuse source code with data. Do some other minor docstring fixups as well, e.g., insert a missing close quote. --- lisp/ChangeLog | 15 +++++++++++++++ lisp/gnus-art.el | 6 +++--- lisp/gnus-sum.el | 2 +- lisp/nndiary.el | 8 ++++---- lisp/nnmail.el | 4 ++-- 5 files changed, 25 insertions(+), 10 deletions(-) diff --git a/lisp/ChangeLog b/lisp/ChangeLog index d3e1e2bf7..b9595381d 100644 --- a/lisp/ChangeLog +++ b/lisp/ChangeLog @@ -1,3 +1,18 @@ +2015-09-02 Paul Eggert + + Escape ` and ' in doc + * gnus-art.el (gnus-article-address-banner-alist) + (gnus-face-properties-alist): + * gnus-sum.el (gnus-newsgroup-variables): + * nndiary.el (nndiary-reminders): + * nnmail.el (nnmail-fancy-expiry-targets, nnmail-split-fancy): + Escape apostrophes and grave accents in docstrings if they + are supposed to stand for themselves and are not quotes. Remove + apostrophes from docstring examples like ‘'(calendar-nth-named-day + -1 0 10 year)’ that confuse source code with data. Do some other + minor docstring fixups as well, e.g., insert a missing close + quote. + 2015-09-01 Katsumi Yamaoka * gnus-util.el (gnus-format-message): diff --git a/lisp/gnus-art.el b/lisp/gnus-art.el index c893544b0..003904922 100644 --- a/lisp/gnus-art.el +++ b/lisp/gnus-art.el @@ -331,7 +331,7 @@ to match a mail address in the From: header, BANNER is one of a symbol If ADDRESS matches author's mail address, it will remove things like advertisements. For example: -\((\"@yoo-hoo\\\\.co\\\\.jp\\\\'\" . \"\\n_+\\nDo You Yoo-hoo!\\\\?\\n.*\\n.*\\n\")) +\((\"@yoo-hoo\\\\.co\\\\.jp\\\\\\='\" . \"\\n_+\\nDo You Yoo-hoo!\\\\?\\n.*\\n.*\\n\")) " :type '(repeat (cons @@ -887,12 +887,12 @@ Here are examples: ;; Specify the altitude of Face images in the From header. \(setq gnus-face-properties-alist - '((pbm . (:face gnus-x-face :ascent 80)) + \\='((pbm . (:face gnus-x-face :ascent 80)) (png . (:ascent 80)))) ;; Show Face images as pressed buttons. \(setq gnus-face-properties-alist - '((pbm . (:face gnus-x-face :relief -2)) + \\='((pbm . (:face gnus-x-face :relief -2)) (png . (:relief -2)))) See the manual for the valid properties for various image types. diff --git a/lisp/gnus-sum.el b/lisp/gnus-sum.el index 447bd5d56..6b90204be 100644 --- a/lisp/gnus-sum.el +++ b/lisp/gnus-sum.el @@ -1656,7 +1656,7 @@ while still allowing them to affect operations done in other buffers. For example: \(setq gnus-newsgroup-variables - '(message-use-followup-to + \\='(message-use-followup-to (gnus-visible-headers . \"^From:\\\\|^Newsgroups:\\\\|^Subject:\\\\|^Date:\\\\|^To:\"))) ") diff --git a/lisp/nndiary.el b/lisp/nndiary.el index 313443820..a6e75b739 100644 --- a/lisp/nndiary.el +++ b/lisp/nndiary.el @@ -151,15 +151,15 @@ maximum in the reminder is not that painful, I think. Although this scheme might appear somewhat weird at a first glance, it is very powerful. In order to make this clear, here are some examples: -- '(0 . day): this is the default value of `nndiary-reminders'. It means +- (0 . day): this is the default value of `nndiary-reminders'. It means pop up the appointments of the day each morning at 00:00. -- '(1 . day): this means pop up the appointments the day before, at 00:00. +- (1 . day): this means pop up the appointments the day before, at 00:00. -- '(6 . hour): for an appointment at 18:30, this would pop up the +- (6 . hour): for an appointment at 18:30, this would pop up the appointment message at 12:00. -- '(360 . minute): for an appointment at 18:30 and 15 seconds, this would +- (360 . minute): for an appointment at 18:30 and 15 seconds, this would pop up the appointment message at 12:30." :group 'nndiary :type '(repeat (cons :format "%v\n" diff --git a/lisp/nnmail.el b/lisp/nnmail.el index 2292849cc..681116017 100644 --- a/lisp/nnmail.el +++ b/lisp/nnmail.el @@ -217,7 +217,7 @@ will try to match against both the From and the To header. Example: \(setq nnmail-fancy-expiry-targets - '((to-from \"boss\" \"nnfolder:Work\") + \\='((to-from \"boss\" \"nnfolder:Work\") (\"Subject\" \"IMPORTANT\" \"nnfolder:IMPORTANT.%Y.%b\") (\"from\" \".*\" \"nnfolder:Archive-%Y\"))) @@ -465,7 +465,7 @@ GROUP: Mail will be stored in GROUP (a string). junk: Mail will be deleted. Use with care! Do not submerge in water! Example: (setq nnmail-split-fancy - '(| (\"Subject\" \"MAKE MONEY FAST\" junk) + \\='(| (\"Subject\" \"MAKE MONEY FAST\" junk) ...other.rules.omitted...)) FIELD must match a complete field name. VALUE must match a complete -- 2.25.1