From: Paul Eggert Date: Wed, 7 Dec 2016 19:29:54 +0000 (-0800) Subject: Fix minor quoting problems in doc strings X-Git-Tag: emacs-25.1.91~35 X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=eeecac7;p=emacs.git Fix minor quoting problems in doc strings --- diff --git a/lisp/calendar/solar.el b/lisp/calendar/solar.el index c78d2bbf519..e92a4dc3f18 100644 --- a/lisp/calendar/solar.el +++ b/lisp/calendar/solar.el @@ -65,7 +65,7 @@ and `am-pm' and `time-zone', both alphabetic strings. For example, the form - '(24-hours \":\" minutes + \\='(24-hours \":\" minutes (if time-zone \" (\") time-zone (if time-zone \")\")) would give military-style times like `21:07 (UTC)'." diff --git a/lisp/cedet/semantic/format.el b/lisp/cedet/semantic/format.el index 1fe703fd09a..923b0a38f85 100644 --- a/lisp/cedet/semantic/format.el +++ b/lisp/cedet/semantic/format.el @@ -603,7 +603,7 @@ UML attribute strings are things like {abstract} or {leaf}." (private . "-") ) "Association list of the form (SYMBOL . \"STRING\") for protection symbols. -This associates a symbol, such as 'public with the st ring \"+\".") +For example, it might associate the symbol `public' with the string \"+\".") (define-overloadable-function semantic-format-tag-uml-protection-to-string (protection-symbol color) "Convert PROTECTION-SYMBOL to a string for UML. diff --git a/lisp/cus-edit.el b/lisp/cus-edit.el index 7826506cc46..72f00b2f959 100644 --- a/lisp/cus-edit.el +++ b/lisp/cus-edit.el @@ -4364,7 +4364,7 @@ option itself, into the file you specify, overwriting any `custom-set-variables' and `custom-set-faces' forms already present in that file. It will not delete any customizations from the old custom file. You should do that manually if that is what you -want. You also have to put something like `(load \"CUSTOM-FILE\") +want. You also have to put something like (load \"CUSTOM-FILE\") in your init file, where CUSTOM-FILE is the actual name of the file. Otherwise, Emacs will not load the file when it starts up, and hence will not set `custom-file' to that file either." diff --git a/lisp/dired-x.el b/lisp/dired-x.el index 088ca81ed8d..67721d6e88a 100644 --- a/lisp/dired-x.el +++ b/lisp/dired-x.el @@ -1060,8 +1060,8 @@ You can set this variable in your ~/.emacs. For example, to add rules for `.foo' and `.bar' files, write (setq dired-guess-shell-alist-user - '((\"\\\\.foo\\\\'\" \"FOO-COMMAND\") - (\"\\\\.bar\\\\'\" + \\='((\"\\\\.foo\\\\\\='\" \"FOO-COMMAND\") + (\"\\\\.bar\\\\\\='\" (if condition \"BAR-COMMAND-1\" \"BAR-COMMAND-2\"))))" diff --git a/lisp/emulation/viper-util.el b/lisp/emulation/viper-util.el index 1254923669f..68500365dc0 100644 --- a/lisp/emulation/viper-util.el +++ b/lisp/emulation/viper-util.el @@ -1332,7 +1332,7 @@ Works best when set in the hooks to various major modes. `reformed-vi' means Viper words are like Emacs words \(as determined using Emacs syntax tables, which are different for different major modes) with two exceptions: the symbol `_' is always part of a word and typical Vi non-word -symbols, such as `,',:,\",),{, etc., are excluded. +symbols like `\\=`', `\\='', `:', `\"', `)', and `{' are excluded. This behaves very close to `strict-vi', but also works well with non-ASCII characters from various alphabets. diff --git a/lisp/gnus/gnus-kill.el b/lisp/gnus/gnus-kill.el index 059a5cdf27d..8eacc468019 100644 --- a/lisp/gnus/gnus-kill.el +++ b/lisp/gnus/gnus-kill.el @@ -118,7 +118,7 @@ the header field or an empty string. If FIELD is an empty string, the entire article body is searched for. REGEXP is a string which is compared with FIELD value. COMMAND is a string representing a valid key sequence in Summary mode or Lisp expression. COMMAND defaults to -'(gnus-summary-mark-as-read nil \"X\"). Make sure that COMMAND is +\(gnus-summary-mark-as-read nil \"X\"). Make sure that COMMAND is executed in the Summary buffer. If the second optional argument ALL is non-nil, the COMMAND is applied to articles which are already marked as read or unread. Articles which are marked are skipped over diff --git a/lisp/gnus/gnus-score.el b/lisp/gnus/gnus-score.el index d3a1139902b..ef096fe7684 100644 --- a/lisp/gnus/gnus-score.el +++ b/lisp/gnus/gnus-score.el @@ -46,7 +46,7 @@ Say you want to use the single score file score files in the \"/ftp.some-where:/pub/score\" directory. (setq gnus-global-score-files - '(\"/ftp.gnus.org:/pub/larsi/ding/score/soc.motss.SCORE\" + \\='(\"/ftp.gnus.org:/pub/larsi/ding/score/soc.motss.SCORE\" \"/ftp.some-where:/pub/score\"))" :group 'gnus-score-files :type '(repeat file)) diff --git a/lisp/gnus/starttls.el b/lisp/gnus/starttls.el index f3ef5e023f9..7c4e3839ce1 100644 --- a/lisp/gnus/starttls.el +++ b/lisp/gnus/starttls.el @@ -153,7 +153,7 @@ These apply when the `starttls' command is used, i.e. when These apply when GnuTLS is used, i.e. when `starttls-use-gnutls' is non-nil. For example, non-TLS compliant servers may require -'(\"--protocols\" \"ssl3\"). Invoke \"gnutls-cli --help\" to +\(\"--protocols\" \"ssl3\"). Invoke \"gnutls-cli --help\" to find out which parameters are available." :version "22.1" :type '(repeat string) diff --git a/lisp/htmlfontify.el b/lisp/htmlfontify.el index fc309bd62ee..82f3a74919f 100644 --- a/lisp/htmlfontify.el +++ b/lisp/htmlfontify.el @@ -522,8 +522,8 @@ Some examples:\n (defvar hfy-sheet-assoc 'please-ignore-this-line "An assoc with elements of the form (face-name style-name . style-string):\n -'((default \"default\" . \"{background: black; color: white}\") - (font-lock-string-face \"string\" . \"{color: rgb(64,224,208)}\"))" ) +\((default \"default\" . \"{background: black; color: white}\") + (font-lock-string-face \"string\" . \"{color: rgb(64,224,208)}\"))" ) (defvar hfy-facemap-assoc 'please-ignore-this-line "An assoc of (point . FACE-SYMBOL) or (point . DEFFACE-LIST) diff --git a/lisp/obsolete/mailpost.el b/lisp/obsolete/mailpost.el index bcd468c2b06..eebaa34de10 100644 --- a/lisp/obsolete/mailpost.el +++ b/lisp/obsolete/mailpost.el @@ -26,7 +26,7 @@ (defun post-mail-send-it () "The MH -post interface for `rmail-mail' to call. -To use it, include \"(setq send-mail-function 'post-mail-send-it)\" in +To use it, include \"(setq send-mail-function \\='post-mail-send-it)\" in site-init." (let ((errbuf (if mail-interactive (generate-new-buffer " post-mail errors") diff --git a/lisp/org/org-table.el b/lisp/org/org-table.el index 20334f30504..3292590e8ed 100644 --- a/lisp/org/org-table.el +++ b/lisp/org/org-table.el @@ -303,7 +303,7 @@ The car of each element is a name of a constant, without the `$' before it. The cdr is the value as a string. For example, if you'd like to use the speed of light in a formula, you would configure - (setq org-table-formula-constants '((\"c\" . \"299792458.\"))) + (setq org-table-formula-constants \\='((\"c\" . \"299792458.\"))) and then use it in an equation like `$1*$c'. diff --git a/lisp/org/ox-latex.el b/lisp/org/ox-latex.el index 2734f90db06..db4075e6612 100644 --- a/lisp/org/ox-latex.el +++ b/lisp/org/ox-latex.el @@ -690,7 +690,7 @@ a list containing two strings: the name of the option, and the value. For example, (setq org-latex-listings-options - '((\"basicstyle\" \"\\\\small\") + \\='((\"basicstyle\" \"\\\\small\") (\"keywordstyle\" \"\\\\color{black}\\\\bfseries\\\\underbar\"))) will typeset the code in a small size font with underlined, bold @@ -737,7 +737,7 @@ be a list containing two strings: the name of the option, and the value. For example, (setq org-latex-minted-options - '((\"bgcolor\" \"bg\") (\"frame\" \"lines\"))) + \\='((\"bgcolor\" \"bg\") (\"frame\" \"lines\"))) will result in src blocks being exported with @@ -758,7 +758,7 @@ It is used during export of src blocks by the listings and minted latex packages. For example, (setq org-latex-custom-lang-environments - '((python \"pythoncode\"))) + \\='((python \"pythoncode\"))) would have the effect that if org encounters begin_src python during latex export it will output diff --git a/lisp/org/ox-man.el b/lisp/org/ox-man.el index 4d9dae5f765..1408e1476d7 100644 --- a/lisp/org/ox-man.el +++ b/lisp/org/ox-man.el @@ -207,7 +207,7 @@ It is used during export of src blocks by the listings and man packages. For example, (setq org-man-custom-lang-environments - '((python \"pythoncode\"))) + \\='((python \"pythoncode\"))) would have the effect that if org encounters begin_src python during man export." diff --git a/lisp/org/ox-odt.el b/lisp/org/ox-odt.el index f2b0c9198b7..944437b56cf 100644 --- a/lisp/org/ox-odt.el +++ b/lisp/org/ox-odt.el @@ -852,7 +852,7 @@ ON-OR-OFF := t | nil For example, with the following configuration \(setq org-odt-table-styles - '((\"TableWithHeaderRowsAndColumns\" \"Custom\" + \\='((\"TableWithHeaderRowsAndColumns\" \"Custom\" ((use-first-row-styles . t) (use-first-column-styles . t))) (\"TableWithHeaderColumns\" \"Custom\" diff --git a/lisp/time.el b/lisp/time.el index ba5792441c4..c9f2df38244 100644 --- a/lisp/time.el +++ b/lisp/time.el @@ -306,9 +306,9 @@ This expression is a list of expressions that can involve the keywords `seconds', all numbers in string form, and `monthname', `dayname', `am-pm', and `time-zone' all alphabetic strings, and `mail' a true/nil value. -For example, the form +For example: - '((substring year -2) \"/\" month \"/\" day + ((substring year -2) \"/\" month \"/\" day \" \" 24-hours \":\" minutes \":\" seconds (if time-zone \" (\") time-zone (if time-zone \")\") (if mail \" Mail\" \"\"))