diff options
| author | Paul Eggert | 2015-11-17 15:28:50 -0800 |
|---|---|---|
| committer | Paul Eggert | 2015-11-17 15:29:35 -0800 |
| commit | ac16149ba470ae8a625d42a61adbb6e84254c675 (patch) | |
| tree | 9575cf0f1c5139a1943f9a18dd444ddc46983aa9 /lisp/textmodes | |
| parent | abf673af29ba2a2e0001ebd1db183377724f0cc4 (diff) | |
| download | emacs-ac16149ba470ae8a625d42a61adbb6e84254c675.tar.gz emacs-ac16149ba470ae8a625d42a61adbb6e84254c675.zip | |
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.el | 4 | ||||
| -rw-r--r-- | lisp/textmodes/page-ext.el | 2 | ||||
| -rw-r--r-- | lisp/textmodes/refbib.el | 6 | ||||
| -rw-r--r-- | lisp/textmodes/refer.el | 6 | ||||
| -rw-r--r-- | lisp/textmodes/reftex-vars.el | 8 | ||||
| -rw-r--r-- | lisp/textmodes/sgml-mode.el | 2 | ||||
| -rw-r--r-- | lisp/textmodes/table.el | 4 | ||||
| -rw-r--r-- | lisp/textmodes/tex-mode.el | 2 | ||||
| -rw-r--r-- | lisp/textmodes/text-mode.el | 2 |
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.") | |||
| 1503 | "The tail of `bibtex-entry-kill-ring' whose car is the last item yanked.") | 1503 | "The tail of `bibtex-entry-kill-ring' whose car is the last item yanked.") |
| 1504 | 1504 | ||
| 1505 | (defvar bibtex-last-kill-command nil | 1505 | (defvar bibtex-last-kill-command nil |
| 1506 | "Type of the last kill command (either 'field or 'entry).") | 1506 | "Type of the last kill command (either `field' or `entry').") |
| 1507 | 1507 | ||
| 1508 | (defvar bibtex-strings | 1508 | (defvar bibtex-strings |
| 1509 | (lazy-completion-table bibtex-strings | 1509 | (lazy-completion-table bibtex-strings |
| @@ -2573,7 +2573,7 @@ Formats current entry according to variable `bibtex-entry-format'." | |||
| 2573 | 2573 | ||
| 2574 | (defun bibtex-field-re-init (regexp-alist type) | 2574 | (defun bibtex-field-re-init (regexp-alist type) |
| 2575 | "Calculate optimized value for bibtex-regexp-TYPE-opt. | 2575 | "Calculate optimized value for bibtex-regexp-TYPE-opt. |
| 2576 | This value is based on bibtex-regexp-TYPE-alist. TYPE is 'braces or 'strings. | 2576 | This value is based on bibtex-regexp-TYPE-alist. TYPE is `braces' or `strings'. |
| 2577 | Return optimized value to be used by `bibtex-format-entry'." | 2577 | Return optimized value to be used by `bibtex-format-entry'." |
| 2578 | (setq regexp-alist | 2578 | (setq regexp-alist |
| 2579 | (mapcar (lambda (e) | 2579 | (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. | |||
| 351 | Narrow to new page if `pages-directory-for-adding-page-narrowing-p' is | 351 | Narrow to new page if `pages-directory-for-adding-page-narrowing-p' is |
| 352 | non-nil. | 352 | non-nil. |
| 353 | 353 | ||
| 354 | Page begins with a '^L' as the default `page-delimiter'. | 354 | Page begins with a `^L' as the default `page-delimiter'. |
| 355 | Use \\[set-page-delimiter] to change the page-delimiter. | 355 | Use \\[set-page-delimiter] to change the page-delimiter. |
| 356 | Point is left in the body of page." | 356 | Point is left in the body of page." |
| 357 | (interactive "sHeader line: ") | 357 | (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. | |||
| 79 | Because titles are capitalized before matching, the abbreviation | 79 | Because titles are capitalized before matching, the abbreviation |
| 80 | for the journal name should be listed as beginning with a capital | 80 | for the journal name should be listed as beginning with a capital |
| 81 | letter, even if it really doesn't. | 81 | letter, even if it really doesn't. |
| 82 | For example, a value of '((\"Aij\" \"{Artificial Intelligence}\") | 82 | For example, a value of ((\"Aij\" \"{Artificial Intelligence}\") |
| 83 | \(\"Ijcai81\" \"ijcai7\")) would expand Aij to the text string | 83 | \(\"Ijcai81\" \"ijcai7\")) would expand Aij to the text string |
| 84 | \"Artificial Intelligence\", but would replace Ijcai81 with the | 84 | \"Artificial Intelligence\", but would replace Ijcai81 with the |
| 85 | BibTeX macro \"ijcai7\"." | 85 | BibTeX macro \"ijcai7\"." |
| @@ -97,7 +97,7 @@ abbreviation. The cadr may be eliminated if is exactly the same as | |||
| 97 | the car. | 97 | the car. |
| 98 | Because titles are capitalized before matching, the abbreviated title | 98 | Because titles are capitalized before matching, the abbreviated title |
| 99 | should be listed as beginning with a capital letter, even if it doesn't. | 99 | should be listed as beginning with a capital letter, even if it doesn't. |
| 100 | For example, a value of '((\"Aij\" \"{Artificial Intelligence}\") | 100 | For example, a value of ((\"Aij\" \"{Artificial Intelligence}\") |
| 101 | \(\"Ijcai81\" \"ijcai7\")) would expand Aij to the text string | 101 | \(\"Ijcai81\" \"ijcai7\")) would expand Aij to the text string |
| 102 | \"Artificial Intelligence\", but would replace Ijcai81 with the | 102 | \"Artificial Intelligence\", but would replace Ijcai81 with the |
| 103 | BibTeX macro \"ijcai7\"." | 103 | BibTeX macro \"ijcai7\"." |
| @@ -115,7 +115,7 @@ The entry must match the given data exactly. | |||
| 115 | should begin with a capital letter. | 115 | should begin with a capital letter. |
| 116 | For example, suppose the title \"Ijcai81\" is used for the proceedings of | 116 | For example, suppose the title \"Ijcai81\" is used for the proceedings of |
| 117 | a conference, and its expansion is the BibTeX macro \"ijcai7\". Then | 117 | a conference, and its expansion is the BibTeX macro \"ijcai7\". Then |
| 118 | `r2b-proceedings-list' should be '((\"Ijcai81\") ...). If instead its | 118 | `r2b-proceedings-list' should be ((\"Ijcai81\") ...). If instead its |
| 119 | expansion were \"Proceedings of the Seventh International Conference | 119 | expansion were \"Proceedings of the Seventh International Conference |
| 120 | on Artificial Intelligence\", then you would NOT need to include Ijcai81 | 120 | on Artificial Intelligence\", then you would NOT need to include Ijcai81 |
| 121 | in `r2b-proceedings-list' (although it wouldn't cause an error)." | 121 | 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 @@ | |||
| 77 | 77 | ||
| 78 | (defcustom refer-bib-directory nil | 78 | (defcustom refer-bib-directory nil |
| 79 | "Directory, or list of directories, to search for \\.bib files. | 79 | "Directory, or list of directories, to search for \\.bib files. |
| 80 | Can be set to 'bibinputs or 'texinputs, in which case the environment | 80 | Can be set to `bibinputs' or `texinputs', in which case the environment |
| 81 | variable BIBINPUTS or TEXINPUTS, respectively, is used to obtain a | 81 | variable BIBINPUTS or TEXINPUTS, respectively, is used to obtain a |
| 82 | list of directories. Useful only if `refer-bib-files' is set to 'dir or | 82 | list of directories. Useful only if `refer-bib-files' is set to `dir' or |
| 83 | a list of file names (without directory). A value of nil indicates the | 83 | a list of file names (without directory). A value of nil indicates the |
| 84 | current working directory. | 84 | current working directory. |
| 85 | 85 | ||
| 86 | If `refer-bib-directory' is 'bibinputs or 'texinputs, it is setq'd to | 86 | If `refer-bib-directory' is `bibinputs' or `texinputs', it is setq'd to |
| 87 | the appropriate list of directories when it is first used. | 87 | the appropriate list of directories when it is first used. |
| 88 | 88 | ||
| 89 | Note that an empty directory is interpreted by BibTeX as indicating | 89 | 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. | |||
| 335 | Value t means, turn on immediately when RefTeX gets started. Then, | 335 | Value t means, turn on immediately when RefTeX gets started. Then, |
| 336 | recentering will work for any TOC window created during the session. | 336 | recentering will work for any TOC window created during the session. |
| 337 | 337 | ||
| 338 | Value 'frame (the default) means, turn automatic recentering on only while the | 338 | Value `frame' (the default) means, turn automatic recentering on only while the |
| 339 | dedicated TOC frame does exist, and do the recentering only in that frame. So | 339 | dedicated TOC frame does exist, and do the recentering only in that frame. So |
| 340 | when creating that frame (with `d' key in an ordinary TOC window), the | 340 | when creating that frame (with `d' key in an ordinary TOC window), the |
| 341 | automatic recentering is turned on. When the frame gets destroyed, automatic | 341 | automatic recentering is turned on. When the frame gets destroyed, automatic |
| @@ -739,7 +739,7 @@ And here is the setup for RefTeX: | |||
| 739 | \\end. Here we use \"linguex\" as this name. | 739 | \\end. Here we use \"linguex\" as this name. |
| 740 | 740 | ||
| 741 | (setq reftex-label-alist | 741 | (setq reftex-label-alist |
| 742 | '((\"linguex\" ?x \"ex:\" \"~\\\\ref{%s}\" nil (\"Example\" \"Ex.\")))) | 742 | \\='((\"linguex\" ?x \"ex:\" \"~\\\\ref{%s}\" nil (\"Example\" \"Ex.\")))) |
| 743 | 743 | ||
| 744 | 2. Write a function to detect the list macros and the determinators as well. | 744 | 2. Write a function to detect the list macros and the determinators as well. |
| 745 | 745 | ||
| @@ -762,7 +762,7 @@ And here is the setup for RefTeX: | |||
| 762 | 762 | ||
| 763 | 3. Tell RefTeX to use this function | 763 | 3. Tell RefTeX to use this function |
| 764 | 764 | ||
| 765 | (setq reftex-special-environment-functions '(my-detect-linguex-list))" | 765 | (setq reftex-special-environment-functions \\='(my-detect-linguex-list))" |
| 766 | :group 'reftex-defining-label-environments | 766 | :group 'reftex-defining-label-environments |
| 767 | :type 'hook) | 767 | :type 'hook) |
| 768 | 768 | ||
| @@ -1206,7 +1206,7 @@ strings. | |||
| 1206 | `reftex-cite-format' directly yourself or set it to the SYMBOL of one of | 1206 | `reftex-cite-format' directly yourself or set it to the SYMBOL of one of |
| 1207 | the predefined styles. The predefined symbols are those which have an | 1207 | the predefined styles. The predefined symbols are those which have an |
| 1208 | association in the constant `reftex-cite-format-builtin'. | 1208 | association in the constant `reftex-cite-format-builtin'. |
| 1209 | E.g.: (setq reftex-cite-format 'natbib)" | 1209 | E.g.: (setq reftex-cite-format \\='natbib)" |
| 1210 | :group 'reftex-citation-support | 1210 | :group 'reftex-citation-support |
| 1211 | :type | 1211 | :type |
| 1212 | `(choice | 1212 | `(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." | |||
| 697 | "Prompt for a tag and insert it, optionally with attributes. | 697 | "Prompt for a tag and insert it, optionally with attributes. |
| 698 | Completion and configuration are done according to `sgml-tag-alist'. | 698 | Completion and configuration are done according to `sgml-tag-alist'. |
| 699 | If you like tags and attributes in uppercase, customize | 699 | If you like tags and attributes in uppercase, customize |
| 700 | `sgml-transformation-function' to 'upcase." | 700 | `sgml-transformation-function' to `upcase'." |
| 701 | (funcall (or skeleton-transformation-function 'identity) | 701 | (funcall (or skeleton-transformation-function 'identity) |
| 702 | (setq sgml-tag-last | 702 | (setq sgml-tag-last |
| 703 | (completing-read | 703 | (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." | |||
| 2938 | (defun table-generate-source (language &optional dest-buffer caption) | 2938 | (defun table-generate-source (language &optional dest-buffer caption) |
| 2939 | "Generate source of the current table in the specified language. | 2939 | "Generate source of the current table in the specified language. |
| 2940 | LANGUAGE is a symbol that specifies the language to describe the | 2940 | LANGUAGE is a symbol that specifies the language to describe the |
| 2941 | structure of the table. It must be either 'html, 'latex or 'cals. | 2941 | structure of the table. It must be either `html', `latex' or `cals'. |
| 2942 | The resulted source text is inserted into DEST-BUFFER and the buffer | 2942 | The resulted source text is inserted into DEST-BUFFER and the buffer |
| 2943 | object is returned. When DEST-BUFFER is omitted or nil the default | 2943 | object is returned. When DEST-BUFFER is omitted or nil the default |
| 2944 | buffer specified in `table-dest-buffer-name' is used. In this case | 2944 | 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 | |||
| 3561 | columns and rows of the table automatically. If COL-DELIM-REGEXP and | 3561 | columns and rows of the table automatically. If COL-DELIM-REGEXP and |
| 3562 | ROW-DELIM-REGEXP are omitted the result table has only one cell and | 3562 | ROW-DELIM-REGEXP are omitted the result table has only one cell and |
| 3563 | the entire region contents is placed in that cell. Optional JUSTIFY | 3563 | the entire region contents is placed in that cell. Optional JUSTIFY |
| 3564 | is one of 'left, 'center or 'right, which specifies the cell | 3564 | is one of `left', `center' or `right', which specifies the cell |
| 3565 | justification. Optional MIN-CELL-WIDTH specifies the minimum cell | 3565 | justification. Optional MIN-CELL-WIDTH specifies the minimum cell |
| 3566 | width. Optional COLUMNS specify the number of columns when | 3566 | width. Optional COLUMNS specify the number of columns when |
| 3567 | ROW-DELIM-REGEXP is not specified. | 3567 | 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 | |||
| 188 | for example, | 188 | for example, |
| 189 | 189 | ||
| 190 | (setq tex-alt-dvi-print-command | 190 | (setq tex-alt-dvi-print-command |
| 191 | '(format \"lpr -P%s\" (read-string \"Use printer: \"))) | 191 | \\='(format \"lpr -P%s\" (read-string \"Use printer: \"))) |
| 192 | 192 | ||
| 193 | would tell \\[tex-print] with a prefix argument to ask you which printer to | 193 | would tell \\[tex-print] with a prefix argument to ask you which printer to |
| 194 | use." | 194 | 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 @@ | |||
| 39 | 39 | ||
| 40 | (defvar text-mode-variant nil | 40 | (defvar text-mode-variant nil |
| 41 | "Non-nil if this buffer's major mode is a variant of Text mode. | 41 | "Non-nil if this buffer's major mode is a variant of Text mode. |
| 42 | Use (derived-mode-p 'text-mode) instead.") | 42 | Use (derived-mode-p \\='text-mode) instead.") |
| 43 | 43 | ||
| 44 | (defvar text-mode-syntax-table | 44 | (defvar text-mode-syntax-table |
| 45 | (let ((st (make-syntax-table))) | 45 | (let ((st (make-syntax-table))) |