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.

diff --git a/lisp/ChangeLog b/lisp/ChangeLog
index d3e1e2b..b959538 100644 (file)
--- a/lisp/ChangeLog
+++ b/lisp/ChangeLog
@@ -1,3 +1,18 @@
+2015-09-02  Paul Eggert  <eggert@cs.ucla.edu>
+
+       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  <yamaoka@jpl.org>
 
        * gnus-util.el (gnus-format-message):
 2015-09-01  Katsumi Yamaoka  <yamaoka@jpl.org>
 
        * gnus-util.el (gnus-format-message):

diff --git a/lisp/gnus-art.el b/lisp/gnus-art.el
index c893544..0039049 100644 (file)
--- 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:
 
 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
 "
   :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
 
 ;; 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
        (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.
        (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 447bd5d..6b90204 100644 (file)
--- 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
 For example:
 
 \(setq gnus-newsgroup-variables

-     '(message-use-followup-to
+     \\='(message-use-followup-to

        (gnus-visible-headers .
         \"^From:\\\\|^Newsgroups:\\\\|^Subject:\\\\|^Date:\\\\|^To:\")))
 ")
        (gnus-visible-headers .
         \"^From:\\\\|^Newsgroups:\\\\|^Subject:\\\\|^Date:\\\\|^To:\")))
 ")

diff --git a/lisp/nndiary.el b/lisp/nndiary.el
index 3134438..a6e75b7 100644 (file)
--- 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:
 
 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.
 
   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.
 
   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"
   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 2292849..6811160 100644 (file)
--- 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
 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\")))
 
        (\"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
 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
            ...other.rules.omitted...))
 
 FIELD must match a complete field name.  VALUE must match a complete