summaryrefslogtreecommitdiff
path: root/lisp/textmodes
diff options
context:
space:
mode:
authorPaul Eggert <eggert@cs.ucla.edu>2015-11-17 15:28:50 -0800
committerPaul Eggert <eggert@cs.ucla.edu>2015-11-17 15:29:35 -0800
commitac16149ba470ae8a625d42a61adbb6e84254c675 (patch)
tree9575cf0f1c5139a1943f9a18dd444ddc46983aa9 /lisp/textmodes
parentabf673af29ba2a2e0001ebd1db183377724f0cc4 (diff)
downloademacs-ac16149ba470ae8a625d42a61adbb6e84254c675.tar.gz
Fix docstring quoting problems with ‘ '’
Problem reported by Artur Malabarba in: http://lists.gnu.org/archive/html/emacs-devel/2015-11/msg01513.html Most of these fixes are to documentation; many involve fixing longstanding quoting glitches that are independent of the recent substitute-command-keys changes. The changes to code are: * lisp/cedet/mode-local.el (mode-local-augment-function-help) (describe-mode-local-overload): Substitute docstrings before displaying them. * lisp/emacs-lisp/cl-macs.el (cl--transform-lambda): Quote the generated docstring for later substitution.
Diffstat (limited to 'lisp/textmodes')
-rw-r--r--lisp/textmodes/bibtex.el4
-rw-r--r--lisp/textmodes/page-ext.el2
-rw-r--r--lisp/textmodes/refbib.el6
-rw-r--r--lisp/textmodes/refer.el6
-rw-r--r--lisp/textmodes/reftex-vars.el8
-rw-r--r--lisp/textmodes/sgml-mode.el2
-rw-r--r--lisp/textmodes/table.el4
-rw-r--r--lisp/textmodes/tex-mode.el2
-rw-r--r--lisp/textmodes/text-mode.el2
9 files changed, 18 insertions, 18 deletions
diff --git a/lisp/textmodes/bibtex.el b/lisp/textmodes/bibtex.el
index df8066ee2fc..deb39d943a8 100644
--- a/lisp/textmodes/bibtex.el
+++ b/lisp/textmodes/bibtex.el
@@ -1503,7 +1503,7 @@ At most `bibtex-entry-kill-ring-max' items are kept here.")
"The tail of `bibtex-entry-kill-ring' whose car is the last item yanked.")
(defvar bibtex-last-kill-command nil
- "Type of the last kill command (either 'field or 'entry).")
+ "Type of the last kill command (either `field' or `entry').")
(defvar bibtex-strings
(lazy-completion-table bibtex-strings
@@ -2573,7 +2573,7 @@ Formats current entry according to variable `bibtex-entry-format'."
(defun bibtex-field-re-init (regexp-alist type)
"Calculate optimized value for bibtex-regexp-TYPE-opt.
-This value is based on bibtex-regexp-TYPE-alist. TYPE is 'braces or 'strings.
+This value is based on bibtex-regexp-TYPE-alist. TYPE is `braces' or `strings'.
Return optimized value to be used by `bibtex-format-entry'."
(setq regexp-alist
(mapcar (lambda (e)
diff --git a/lisp/textmodes/page-ext.el b/lisp/textmodes/page-ext.el
index 99962c75897..c7a2f258f86 100644
--- a/lisp/textmodes/page-ext.el
+++ b/lisp/textmodes/page-ext.el
@@ -351,7 +351,7 @@ Else insert at exact location of point.
Narrow to new page if `pages-directory-for-adding-page-narrowing-p' is
non-nil.
-Page begins with a '^L' as the default `page-delimiter'.
+Page begins with a `^L' as the default `page-delimiter'.
Use \\[set-page-delimiter] to change the page-delimiter.
Point is left in the body of page."
(interactive "sHeader line: ")
diff --git a/lisp/textmodes/refbib.el b/lisp/textmodes/refbib.el
index 424b6d0f6a1..e5b89a24a52 100644
--- a/lisp/textmodes/refbib.el
+++ b/lisp/textmodes/refbib.el
@@ -79,7 +79,7 @@ may be eliminated if is exactly the same as the car.
Because titles are capitalized before matching, the abbreviation
for the journal name should be listed as beginning with a capital
letter, even if it really doesn't.
- For example, a value of '((\"Aij\" \"{Artificial Intelligence}\")
+ For example, a value of ((\"Aij\" \"{Artificial Intelligence}\")
\(\"Ijcai81\" \"ijcai7\")) would expand Aij to the text string
\"Artificial Intelligence\", but would replace Ijcai81 with the
BibTeX macro \"ijcai7\"."
@@ -97,7 +97,7 @@ abbreviation. The cadr may be eliminated if is exactly the same as
the car.
Because titles are capitalized before matching, the abbreviated title
should be listed as beginning with a capital letter, even if it doesn't.
- For example, a value of '((\"Aij\" \"{Artificial Intelligence}\")
+ For example, a value of ((\"Aij\" \"{Artificial Intelligence}\")
\(\"Ijcai81\" \"ijcai7\")) would expand Aij to the text string
\"Artificial Intelligence\", but would replace Ijcai81 with the
BibTeX macro \"ijcai7\"."
@@ -115,7 +115,7 @@ The entry must match the given data exactly.
should begin with a capital letter.
For example, suppose the title \"Ijcai81\" is used for the proceedings of
a conference, and its expansion is the BibTeX macro \"ijcai7\". Then
-`r2b-proceedings-list' should be '((\"Ijcai81\") ...). If instead its
+`r2b-proceedings-list' should be ((\"Ijcai81\") ...). If instead its
expansion were \"Proceedings of the Seventh International Conference
on Artificial Intelligence\", then you would NOT need to include Ijcai81
in `r2b-proceedings-list' (although it wouldn't cause an error)."
diff --git a/lisp/textmodes/refer.el b/lisp/textmodes/refer.el
index 22dc7dc9165..dfdda8a5742 100644
--- a/lisp/textmodes/refer.el
+++ b/lisp/textmodes/refer.el
@@ -77,13 +77,13 @@
(defcustom refer-bib-directory nil
"Directory, or list of directories, to search for \\.bib files.
-Can be set to 'bibinputs or 'texinputs, in which case the environment
+Can be set to `bibinputs' or `texinputs', in which case the environment
variable BIBINPUTS or TEXINPUTS, respectively, is used to obtain a
-list of directories. Useful only if `refer-bib-files' is set to 'dir or
+list of directories. Useful only if `refer-bib-files' is set to `dir' or
a list of file names (without directory). A value of nil indicates the
current working directory.
-If `refer-bib-directory' is 'bibinputs or 'texinputs, it is setq'd to
+If `refer-bib-directory' is `bibinputs' or `texinputs', it is setq'd to
the appropriate list of directories when it is first used.
Note that an empty directory is interpreted by BibTeX as indicating
diff --git a/lisp/textmodes/reftex-vars.el b/lisp/textmodes/reftex-vars.el
index 97c8af365e8..3f7a6f34dc6 100644
--- a/lisp/textmodes/reftex-vars.el
+++ b/lisp/textmodes/reftex-vars.el
@@ -335,7 +335,7 @@ more than `reftex-idle-time' seconds.
Value t means, turn on immediately when RefTeX gets started. Then,
recentering will work for any TOC window created during the session.
-Value 'frame (the default) means, turn automatic recentering on only while the
+Value `frame' (the default) means, turn automatic recentering on only while the
dedicated TOC frame does exist, and do the recentering only in that frame. So
when creating that frame (with `d' key in an ordinary TOC window), the
automatic recentering is turned on. When the frame gets destroyed, automatic
@@ -739,7 +739,7 @@ And here is the setup for RefTeX:
\\end. Here we use \"linguex\" as this name.
(setq reftex-label-alist
- '((\"linguex\" ?x \"ex:\" \"~\\\\ref{%s}\" nil (\"Example\" \"Ex.\"))))
+ \\='((\"linguex\" ?x \"ex:\" \"~\\\\ref{%s}\" nil (\"Example\" \"Ex.\"))))
2. Write a function to detect the list macros and the determinators as well.
@@ -762,7 +762,7 @@ And here is the setup for RefTeX:
3. Tell RefTeX to use this function
- (setq reftex-special-environment-functions '(my-detect-linguex-list))"
+ (setq reftex-special-environment-functions \\='(my-detect-linguex-list))"
:group 'reftex-defining-label-environments
:type 'hook)
@@ -1206,7 +1206,7 @@ strings.
`reftex-cite-format' directly yourself or set it to the SYMBOL of one of
the predefined styles. The predefined symbols are those which have an
association in the constant `reftex-cite-format-builtin'.
-E.g.: (setq reftex-cite-format 'natbib)"
+E.g.: (setq reftex-cite-format \\='natbib)"
:group 'reftex-citation-support
:type
`(choice
diff --git a/lisp/textmodes/sgml-mode.el b/lisp/textmodes/sgml-mode.el
index 55a1e6d26db..239112bca33 100644
--- a/lisp/textmodes/sgml-mode.el
+++ b/lisp/textmodes/sgml-mode.el
@@ -697,7 +697,7 @@ This only works for Latin-1 input."
"Prompt for a tag and insert it, optionally with attributes.
Completion and configuration are done according to `sgml-tag-alist'.
If you like tags and attributes in uppercase, customize
-`sgml-transformation-function' to 'upcase."
+`sgml-transformation-function' to `upcase'."
(funcall (or skeleton-transformation-function 'identity)
(setq sgml-tag-last
(completing-read
diff --git a/lisp/textmodes/table.el b/lisp/textmodes/table.el
index 151d64808af..97da43757da 100644
--- a/lisp/textmodes/table.el
+++ b/lisp/textmodes/table.el
@@ -2938,7 +2938,7 @@ WHERE is provided the cell and table at that location is reported."
(defun table-generate-source (language &optional dest-buffer caption)
"Generate source of the current table in the specified language.
LANGUAGE is a symbol that specifies the language to describe the
-structure of the table. It must be either 'html, 'latex or 'cals.
+structure of the table. It must be either `html', `latex' or `cals'.
The resulted source text is inserted into DEST-BUFFER and the buffer
object is returned. When DEST-BUFFER is omitted or nil the default
buffer specified in `table-dest-buffer-name' is used. In this case
@@ -3561,7 +3561,7 @@ delimiter regular expressions. This parsing determines the number of
columns and rows of the table automatically. If COL-DELIM-REGEXP and
ROW-DELIM-REGEXP are omitted the result table has only one cell and
the entire region contents is placed in that cell. Optional JUSTIFY
-is one of 'left, 'center or 'right, which specifies the cell
+is one of `left', `center' or `right', which specifies the cell
justification. Optional MIN-CELL-WIDTH specifies the minimum cell
width. Optional COLUMNS specify the number of columns when
ROW-DELIM-REGEXP is not specified.
diff --git a/lisp/textmodes/tex-mode.el b/lisp/textmodes/tex-mode.el
index c9d347da02d..22bb8ca41db 100644
--- a/lisp/textmodes/tex-mode.el
+++ b/lisp/textmodes/tex-mode.el
@@ -188,7 +188,7 @@ If two printers are not enough of a choice, you can set the variable
for example,
(setq tex-alt-dvi-print-command
- '(format \"lpr -P%s\" (read-string \"Use printer: \")))
+ \\='(format \"lpr -P%s\" (read-string \"Use printer: \")))
would tell \\[tex-print] with a prefix argument to ask you which printer to
use."
diff --git a/lisp/textmodes/text-mode.el b/lisp/textmodes/text-mode.el
index 1466556ab59..1e0a949ed05 100644
--- a/lisp/textmodes/text-mode.el
+++ b/lisp/textmodes/text-mode.el
@@ -39,7 +39,7 @@
(defvar text-mode-variant nil
"Non-nil if this buffer's major mode is a variant of Text mode.
-Use (derived-mode-p 'text-mode) instead.")
+Use (derived-mode-p \\='text-mode) instead.")
(defvar text-mode-syntax-table
(let ((st (make-syntax-table)))