diff options
author | Paul Eggert <eggert@cs.ucla.edu> | 2015-11-17 15:28:50 -0800 |
---|---|---|
committer | Paul Eggert <eggert@cs.ucla.edu> | 2015-11-17 15:29:35 -0800 |
commit | ac16149ba470ae8a625d42a61adbb6e84254c675 (patch) | |
tree | 9575cf0f1c5139a1943f9a18dd444ddc46983aa9 /lisp/progmodes | |
parent | abf673af29ba2a2e0001ebd1db183377724f0cc4 (diff) | |
download | emacs-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/progmodes')
-rw-r--r-- | lisp/progmodes/cc-mode.el | 4 | ||||
-rw-r--r-- | lisp/progmodes/compile.el | 4 | ||||
-rw-r--r-- | lisp/progmodes/cpp.el | 2 | ||||
-rw-r--r-- | lisp/progmodes/f90.el | 4 | ||||
-rw-r--r-- | lisp/progmodes/flymake.el | 2 | ||||
-rw-r--r-- | lisp/progmodes/fortran.el | 4 | ||||
-rw-r--r-- | lisp/progmodes/gdb-mi.el | 6 | ||||
-rw-r--r-- | lisp/progmodes/gud.el | 2 | ||||
-rw-r--r-- | lisp/progmodes/hideif.el | 32 | ||||
-rw-r--r-- | lisp/progmodes/hideshow.el | 6 | ||||
-rw-r--r-- | lisp/progmodes/idlwave.el | 26 | ||||
-rw-r--r-- | lisp/progmodes/js.el | 12 | ||||
-rw-r--r-- | lisp/progmodes/mantemp.el | 2 | ||||
-rw-r--r-- | lisp/progmodes/pascal.el | 4 | ||||
-rw-r--r-- | lisp/progmodes/python.el | 8 | ||||
-rw-r--r-- | lisp/progmodes/sh-script.el | 2 | ||||
-rw-r--r-- | lisp/progmodes/simula.el | 8 | ||||
-rw-r--r-- | lisp/progmodes/sql.el | 4 | ||||
-rw-r--r-- | lisp/progmodes/vera-mode.el | 2 | ||||
-rw-r--r-- | lisp/progmodes/verilog-mode.el | 12 | ||||
-rw-r--r-- | lisp/progmodes/vhdl-mode.el | 30 |
21 files changed, 88 insertions, 88 deletions
diff --git a/lisp/progmodes/cc-mode.el b/lisp/progmodes/cc-mode.el index a46ee15ed5e..37cae099635 100644 --- a/lisp/progmodes/cc-mode.el +++ b/lisp/progmodes/cc-mode.el @@ -479,7 +479,7 @@ preferably use the `c-mode-menu' language constant directly." and the line breaking/filling code. Intended to be used by other packages that embed CC Mode. -MODE is the CC Mode flavor to set up, e.g. 'c-mode or 'java-mode. +MODE is the CC Mode flavor to set up, e.g. `c-mode' or `java-mode'. DEFAULT-STYLE tells which indentation style to install. It has the same format as `c-default-style'. @@ -647,7 +647,7 @@ In addition to the work done by `c-basic-common-init' and customary in CC Mode modes but which aren't strictly necessary for CC Mode to operate correctly. -MODE is the symbol for the mode to initialize, like 'c-mode. See +MODE is the symbol for the mode to initialize, like `c-mode'. See `c-basic-common-init' for details. It's only optional to be compatible with old code; callers should always specify it." diff --git a/lisp/progmodes/compile.el b/lisp/progmodes/compile.el index 9e2d625a4d4..d9b4b6984ff 100644 --- a/lisp/progmodes/compile.el +++ b/lisp/progmodes/compile.el @@ -951,7 +951,7 @@ from a different message." (defvar compilation--previous-directory-cache nil "A pair (POS . RES) caching the result of previous directory search. Basically, this pair says that calling - (previous-single-property-change POS 'compilation-directory) + (previous-single-property-change POS \\='compilation-directory) returned RES, i.e. there is no change of `compilation-directory' between POS and RES.") (make-variable-buffer-local 'compilation--previous-directory-cache) @@ -967,7 +967,7 @@ POS and RES.") (t (setq compilation--previous-directory-cache nil)))) (defun compilation--previous-directory (pos) - "Like (previous-single-property-change POS 'compilation-directory), but faster." + "Like (previous-single-property-change POS \\='compilation-directory), but faster." ;; This avoids an N² behavior when there's no/few compilation-directory ;; entries, in which case each call to previous-single-property-change ;; ends up having to walk very far back to find the last change. diff --git a/lisp/progmodes/cpp.el b/lisp/progmodes/cpp.el index 3cf17f48b5f..faa917a87a7 100644 --- a/lisp/progmodes/cpp.el +++ b/lisp/progmodes/cpp.el @@ -664,7 +664,7 @@ otherwise make them unwritable." (defun cpp-edit-write (symbol branch) "Set which branches of SYMBOL should be writable to BRANCH. -BRANCH should be either nil (false branch), t (true branch) or 'both." +BRANCH should be either nil (false branch), t (true branch) or `both'." (interactive (list (cpp-choose-symbol) (cpp-choose-branch))) (setcar (nthcdr 3 (cpp-edit-list-entry-get-or-create symbol)) branch) (cpp-edit-reset)) diff --git a/lisp/progmodes/f90.el b/lisp/progmodes/f90.el index 0e333f1f7ed..324efb0e1bb 100644 --- a/lisp/progmodes/f90.el +++ b/lisp/progmodes/f90.el @@ -295,7 +295,7 @@ the constant `f90-no-break-re' ensures that such tokens are not split." (defcustom f90-auto-keyword-case nil "Automatic case conversion of keywords. -The options are 'downcase-word, 'upcase-word, 'capitalize-word and nil." +The options are `downcase-word', `upcase-word', `capitalize-word' and nil." :type '(choice (const downcase-word) (const upcase-word) (const capitalize-word) (const nil)) :safe (lambda (value) (memq value '(downcase-word @@ -2330,7 +2330,7 @@ Any other key combination is executed normally." ;; Change the keywords according to argument. (defun f90-change-keywords (change-word &optional beg end) "Change the case of F90 keywords in the region (if specified) or buffer. -CHANGE-WORD should be one of 'upcase-word, 'downcase-word, 'capitalize-word." +CHANGE-WORD should be one of `upcase-word', `downcase-word', `capitalize-word'." (save-excursion (setq beg (or beg (point-min)) end (or end (point-max))) diff --git a/lisp/progmodes/flymake.el b/lisp/progmodes/flymake.el index 3adadd1386e..882ac064b82 100644 --- a/lisp/progmodes/flymake.el +++ b/lisp/progmodes/flymake.el @@ -989,7 +989,7 @@ For the format of LINE-ERR-INFO, see `flymake-ler-make-ler'." (funcall flymake-get-project-include-dirs-function basedir)) (defun flymake-get-system-include-dirs () - "System include dirs - from the 'INCLUDE' env setting." + "System include dirs - from the `INCLUDE' env setting." (let* ((includes (getenv "INCLUDE"))) (if includes (split-string includes path-separator t) nil))) diff --git a/lisp/progmodes/fortran.el b/lisp/progmodes/fortran.el index ef470055065..33fe4b37cf8 100644 --- a/lisp/progmodes/fortran.el +++ b/lisp/progmodes/fortran.el @@ -1258,7 +1258,7 @@ Auto-indent does not happen if a numeric ARG is used." (defun fortran-previous-statement () "Move point to beginning of the previous Fortran statement. -Returns 'first-statement if that statement is the first +Returns `first-statement' if that statement is the first non-comment Fortran statement in the file, and nil otherwise. Directive lines are treated as comments." (interactive) @@ -1290,7 +1290,7 @@ Directive lines are treated as comments." (defun fortran-next-statement () "Move point to beginning of the next Fortran statement. -Returns 'last-statement if that statement is the last +Returns `last-statement' if that statement is the last non-comment Fortran statement in the file, and nil otherwise. Directive lines are treated as comments." (interactive) diff --git a/lisp/progmodes/gdb-mi.el b/lisp/progmodes/gdb-mi.el index 4bee7c1dfa2..16f82ccb47f 100644 --- a/lisp/progmodes/gdb-mi.el +++ b/lisp/progmodes/gdb-mi.el @@ -1630,7 +1630,7 @@ this trigger is subscribed to `gdb-buf-publisher' and called with (make-comint-in-buffer "gdb-inferior" (current-buffer) nil)) (defcustom gdb-display-io-nopopup nil - "When non-nil, and the 'gdb-inferior-io buffer is buried, don't pop it up." + "When non-nil, and the `gdb-inferior-io' buffer is buried, don't pop it up." :type 'boolean :group 'gdb :version "25.1") @@ -2788,7 +2788,7 @@ buffer with `gdb-bind-function-to-buffer'. If SIGNAL-LIST is non-nil, GDB-COMMAND is sent only when the defined trigger is called with an argument from SIGNAL-LIST. It's not recommended to define triggers with empty SIGNAL-LIST. -Normally triggers should respond at least to 'update signal. +Normally triggers should respond at least to the `update' signal. Normally the trigger defined by this command must be called from the buffer where HANDLER-NAME must work. This should be done so @@ -3252,7 +3252,7 @@ corresponding to the mode line clicked." "Define a NAME command which will act upon thread on the current line. CUSTOM-DEFUN may use locally bound `thread' variable, which will -be the value of 'gdb-thread property of the current line. +be the value of `gdb-thread' property of the current line. If `gdb-thread' is nil, error is signaled." `(defun ,name (&optional event) ,(when doc doc) diff --git a/lisp/progmodes/gud.el b/lisp/progmodes/gud.el index 1284ef2857a..024547cc487 100644 --- a/lisp/progmodes/gud.el +++ b/lisp/progmodes/gud.el @@ -3080,7 +3080,7 @@ the character after the end of the expr." "Scan from SPAN-START to SPAN-END for punctuation characters. If `->' is found, return `?.'. If `.' is found, return `?.'. If any other punctuation is found, return `??'. -If no punctuation is found, return `? '." +If no punctuation is found, return `?\\s'." (let ((result ?\s) (syntax)) (while (< span-start span-end) diff --git a/lisp/progmodes/hideif.el b/lisp/progmodes/hideif.el index e0d25c4439d..71646d312c4 100644 --- a/lisp/progmodes/hideif.el +++ b/lisp/progmodes/hideif.el @@ -653,7 +653,7 @@ that form should be displayed.") (stringp id)))) (defun hif-define-operator (tokens) - "`Upgrade' hif-define xxx to '(hif-define xxx)' so it won't be substituted." + "\"Upgrade\" hif-define XXX to `(hif-define XXX)' so it won't be substituted." (let ((result nil) (tok nil)) (while (setq tok (pop tokens)) @@ -766,7 +766,7 @@ macros to prevent self-reference." (error "Error: unexpected token: %s" hif-token))))) (defun hif-exprlist () - "Parse an exprlist: expr { ',' expr}." + "Parse an exprlist: expr { `,' expr}." (let ((result (hif-expr))) (if (eq hif-token 'hif-comma) (let ((temp (list result))) @@ -780,7 +780,7 @@ macros to prevent self-reference." (defun hif-expr () "Parse an expression as found in #if. -expr : or-expr | or-expr '?' expr ':' expr." +expr : or-expr | or-expr `?' expr `:' expr." (let ((result (hif-or-expr)) middle) (while (eq hif-token 'hif-conditional) @@ -794,7 +794,7 @@ expr : or-expr | or-expr '?' expr ':' expr." result)) (defun hif-or-expr () - "Parse an or-expr : and-expr | or-expr '||' and-expr." + "Parse an or-expr : and-expr | or-expr `||' and-expr." (let ((result (hif-and-expr))) (while (eq hif-token 'hif-or) (hif-nexttoken) @@ -802,7 +802,7 @@ expr : or-expr | or-expr '?' expr ':' expr." result)) (defun hif-and-expr () - "Parse an and-expr : logior-expr | and-expr '&&' logior-expr." + "Parse an and-expr : logior-expr | and-expr `&&' logior-expr." (let ((result (hif-logior-expr))) (while (eq hif-token 'hif-and) (hif-nexttoken) @@ -810,7 +810,7 @@ expr : or-expr | or-expr '?' expr ':' expr." result)) (defun hif-logior-expr () - "Parse a logor-expr : logxor-expr | logor-expr '|' logxor-expr." + "Parse a logor-expr : logxor-expr | logor-expr `|' logxor-expr." (let ((result (hif-logxor-expr))) (while (eq hif-token 'hif-logior) (hif-nexttoken) @@ -818,7 +818,7 @@ expr : or-expr | or-expr '?' expr ':' expr." result)) (defun hif-logxor-expr () - "Parse a logxor-expr : logand-expr | logxor-expr '^' logand-expr." + "Parse a logxor-expr : logand-expr | logxor-expr `^' logand-expr." (let ((result (hif-logand-expr))) (while (eq hif-token 'hif-logxor) (hif-nexttoken) @@ -826,7 +826,7 @@ expr : or-expr | or-expr '?' expr ':' expr." result)) (defun hif-logand-expr () - "Parse a logand-expr : eq-expr | logand-expr '&' eq-expr." + "Parse a logand-expr : eq-expr | logand-expr `&' eq-expr." (let ((result (hif-eq-expr))) (while (eq hif-token 'hif-logand) (hif-nexttoken) @@ -866,7 +866,7 @@ expr : or-expr | or-expr '?' expr ':' expr." (defun hif-math () "Parse an expression with + or -. - math : muldiv | math '+|-' muldiv." + math : muldiv | math `+'|`-' muldiv." (let ((result (hif-muldiv-expr)) (math-op nil)) (while (memq hif-token '(hif-plus hif-minus)) @@ -877,7 +877,7 @@ expr : or-expr | or-expr '?' expr ':' expr." (defun hif-muldiv-expr () "Parse an expression with *,/,%. - muldiv : factor | muldiv '*|/|%' factor." + muldiv : factor | muldiv `*'|`/'|`%' factor." (let ((result (hif-factor)) (math-op nil)) (while (memq hif-token '(hif-multiply hif-divide hif-modulo)) @@ -888,8 +888,8 @@ expr : or-expr | or-expr '?' expr ':' expr." (defun hif-factor () "Parse a factor. -factor : '!' factor | '~' factor | '(' expr ')' | 'defined(' id ')' | - 'id(parmlist)' | strings | id." +factor : `!' factor | `~' factor | `(' expr `)' | `defined(' id `)' | + id `(' parmlist `)' | strings | id." (cond ((eq hif-token 'hif-not) (hif-nexttoken) @@ -999,9 +999,9 @@ This macro cannot be evaluated alone without parameters input." (defun hif-token-concat (a b) "Concatenate two tokens into a longer token. Currently support only simple token concatenation. Also support weird (but -valid) token concatenation like '>' ## '>' becomes '>>'. Here we take care only +valid) token concatenation like `>' ## `>' becomes `>>'. Here we take care only those that can be evaluated during preprocessing time and ignore all those that -can only be evaluated at C(++) runtime (like '++', '--' and '+='...)." +can only be evaluated at C(++) runtime (like `++', `--' and `+='...)." (if (or (memq a hif-valid-token-list) (memq b hif-valid-token-list)) (let* ((ra (car (rassq a hif-token-alist))) @@ -1632,8 +1632,8 @@ not be expanded." result)))) (defun hif-parse-macro-arglist (str) - "Parse argument list formatted as '( arg1 [ , argn] [...] )'. -The '...' is also included. Return a list of the arguments, if '...' exists the + "Parse argument list formatted as `( arg1 [ , argn] [...] )'. +The `...' is also included. Return a list of the arguments, if `...' exists the first arg will be `hif-etc'." (let* ((hif-simple-token-only nil) ; Dynamic binding var for `hif-tokenize' (tokenlist diff --git a/lisp/progmodes/hideshow.el b/lisp/progmodes/hideshow.el index dba497b1f41..ebc5e2404c8 100644 --- a/lisp/progmodes/hideshow.el +++ b/lisp/progmodes/hideshow.el @@ -439,9 +439,9 @@ See `hs-c-like-adjust-block-beginning' for an example of using this.") You can display this in the mode line by adding the symbol `hs-headline' to the variable `mode-line-format'. For example, - (unless (memq 'hs-headline mode-line-format) + (unless (memq \\='hs-headline mode-line-format) (setq mode-line-format - (append '(\"-\" hs-headline) mode-line-format))) + (append \\='(\"-\" hs-headline) mode-line-format))) Note that `mode-line-format' is buffer-local.") @@ -934,7 +934,7 @@ if ARG is omitted or nil. When hideshow minor mode is on, the menu bar is augmented with hideshow commands and the hideshow commands are enabled. -The value '(hs . t) is added to `buffer-invisibility-spec'. +The value (hs . t) is added to `buffer-invisibility-spec'. The main commands are: `hs-hide-all', `hs-show-all', `hs-hide-block', `hs-show-block', `hs-hide-level' and `hs-toggle-hiding'. There is also diff --git a/lisp/progmodes/idlwave.el b/lisp/progmodes/idlwave.el index ac2259df6a4..1546e9ad6e6 100644 --- a/lisp/progmodes/idlwave.el +++ b/lisp/progmodes/idlwave.el @@ -808,7 +808,7 @@ See `idlwave-check-abbrev'." (defcustom idlwave-abbrev-change-case nil "Non-nil means all abbrevs will be forced to either upper or lower case. If the value t, all expanded abbrevs will be upper case. -If the value is 'down then abbrevs will be forced to lower case. +If the value is `down' then abbrevs will be forced to lower case. If nil, the case will not change. If `idlwave-reserved-word-upcase' is non-nil, reserved words will always be upper case, regardless of this variable." @@ -963,7 +963,7 @@ a file." (defcustom idlwave-doc-modifications-keyword "HISTORY" "The modifications keyword to use with the log documentation commands. -A ':' is added to the keyword end. +A `:' is added to the keyword end. Inserted by doc-header and used to position logs by doc-modification. If nil it will not be inserted." :group 'idlwave-documentation @@ -999,7 +999,7 @@ it without compromising backwards-compatibility." (defcustom idlwave-shell-command-line-options nil "A list of command line options for calling the IDL program. Since IDL is executed directly without going through a shell like /bin/sh, -this should be a list of strings like '(\"-rt=file\" \"-nw\") with a separate +this should be a list of strings like (\"-rt=file\" \"-nw\") with a separate string for each argument. But you may also give a single string which contains the options whitespace-separated. Emacs will be kind enough to split it for you." @@ -1021,7 +1021,7 @@ Obsolete, if the IDL Assistant is being used for help." Will be used to bind debugging commands in the shell buffer and in all source buffers. These are additional convenience bindings, the debugging commands are always available with the `C-c C-d' prefix. -If you set this to '(control shift), this means setting a breakpoint will +If you set this to (control shift), this means setting a breakpoint will be on `C-S-b', compiling a source file on `C-S-c' etc. Possible modifiers are `control', `meta', `super', `hyper', `alt', and `shift'." :group 'idlwave-shell-general-setup @@ -1557,15 +1557,15 @@ KEY is a string - same as for the `define-key' function. CMD is a function of no arguments or a list to be evaluated. CMD is bound to KEY in `idlwave-mode-map' by defining an anonymous function calling `self-insert-command' followed by CMD. If KEY contains more than one -character a binding will only be set if SELECT is 'both. +character a binding will only be set if SELECT is `both'. \(KEY . CMD) is also placed in the `idlwave-indent-expand-table', replacing any previous value for KEY. If a binding is not set then it will instead be placed in `idlwave-indent-action-table'. If the optional argument SELECT is nil then an action and binding are -created. If SELECT is 'noaction, then a binding is always set and no -action is created. If SELECT is 'both then an action and binding +created. If SELECT is `noaction', then a binding is always set and no +action is created. If SELECT is `both' then an action and binding will both be created even if KEY contains more than one character. Otherwise, if SELECT is non-nil then only an action is created. @@ -2690,7 +2690,7 @@ statement." (append st (match-end 0)))))) (defun idlwave-expand-equal (&optional before after is-action) - "Pad '=' with spaces. + "Pad `=' with spaces. Two cases: Assignment statement, and keyword assignment. Which case is determined using `idlwave-start-of-substatement' and `idlwave-statement-type'. The equal sign will be surrounded by BEFORE @@ -2835,7 +2835,7 @@ ACTION is a list (REG . FUNC). REG is a regular expression. FUNC is either a function name to be called with `funcall' or a list to be evaluated with `eval'. The action performed by FUNC should leave point after the match for REG - otherwise an infinite loop may be -entered. FUNC is always passed a final argument of 'is-action, so it +entered. FUNC is always passed a final argument of `is-action', so it can discriminate between being run as an action, or a key binding." (let ((action-key (car action)) (action-routine (cdr action))) @@ -6240,7 +6240,7 @@ If yes, return the index (>=1)." (defun idlwave-all-method-classes (method &optional type) "Return all classes which have a method METHOD. -TYPE is 'fun or 'pro. +TYPE is `fun' or `pro'. When TYPE is not specified, both procedures and functions will be considered." (if (null method) (mapcar 'car (idlwave-class-alist)) @@ -6255,7 +6255,7 @@ When TYPE is not specified, both procedures and functions will be considered." (defun idlwave-all-method-keyword-classes (method keyword &optional type) "Return all classes which have a method METHOD with keyword KEYWORD. -TYPE is 'fun or 'pro. +TYPE is `fun' or `pro'. When TYPE is not specified, both procedures and functions will be considered." (if (or (null method) (null keyword)) @@ -6644,8 +6644,8 @@ This function is not general, can only be used for completion stuff." special-selector) "Perform TYPE completion of word before point against LIST. SELECTOR is the PREDICATE argument for the completion function. Show -PROMPT in echo area. TYPE is one of the intern types, e.g. 'function, -'procedure, 'class-tag, 'keyword, 'sysvar, etc. SPECIAL-SELECTOR is +PROMPT in echo area. TYPE is one of the intern types, e.g., `function', +`procedure', `class-tag', `keyword', `sysvar'. SPECIAL-SELECTOR is used only once, for `all-completions', and can be used to, e.g., accumulate information on matching completions." (let* ((completion-ignore-case t) diff --git a/lisp/progmodes/js.el b/lisp/progmodes/js.el index 3ce1c17352f..356a31db094 100644 --- a/lisp/progmodes/js.el +++ b/lisp/progmodes/js.el @@ -97,7 +97,7 @@ name.") "\\.\\(" js--name-re "\\)\\s-*?=\\s-*?\\(function\\)\\_>") "Regexp matching an explicit JavaScript prototype \"method\" declaration. Group 1 is a (possibly-dotted) class name, group 2 is a method name, -and group 3 is the 'function' keyword.") +and group 3 is the `function' keyword.") (defconst js--plain-class-re (concat "^\\s-*\\(" js--dotted-name-re "\\)\\.prototype" @@ -831,7 +831,7 @@ lines." (defun js--forward-function-decl () "Move forward over a JavaScript function declaration. -This puts point at the 'function' keyword. +This puts point at the `function' keyword. If this is a syntactically-correct non-expression function, return the name of the function, or t if the name could not be @@ -3366,8 +3366,8 @@ left-to-right." (defun js--read-tab (prompt) "Read a Mozilla tab with prompt PROMPT. -Return a cons of (TYPE . OBJECT). TYPE is either 'window or -'tab, and OBJECT is a JavaScript handle to a ChromeWindow or a +Return a cons of (TYPE . OBJECT). TYPE is either `window' or +`tab', and OBJECT is a JavaScript handle to a ChromeWindow or a browser, respectively." ;; Prime IDO @@ -3778,12 +3778,12 @@ If one hasn't been set, or if it's stale, prompt for a new one." "Major mode for editing JSX. To customize the indentation for this mode, set the SGML offset -variables (`sgml-basic-offset', `sgml-attribute-offset' et al) +variables (`sgml-basic-offset', `sgml-attribute-offset' et al.) locally, like so: (defun set-jsx-indentation () (setq-local sgml-basic-offset js-indent-level)) - (add-hook 'js-jsx-mode-hook #'set-jsx-indentation)" + (add-hook \\='js-jsx-mode-hook #\\='set-jsx-indentation)" :group 'js (setq-local indent-line-function #'js-jsx-indent-line)) diff --git a/lisp/progmodes/mantemp.el b/lisp/progmodes/mantemp.el index a0f50fc0f19..6c89a518049 100644 --- a/lisp/progmodes/mantemp.el +++ b/lisp/progmodes/mantemp.el @@ -128,7 +128,7 @@ (defun mantemp-insert-cxx-syntax () "Insert C++ syntax around each template class and function. -Insert 'template class' for classes, 'template' for +Insert `template class' for classes, 'template' for functions and add the statement delimiter `;' at the end of the lines." (save-excursion diff --git a/lisp/progmodes/pascal.el b/lisp/progmodes/pascal.el index 454367c10fa..904001d3383 100644 --- a/lisp/progmodes/pascal.el +++ b/lisp/progmodes/pascal.el @@ -236,8 +236,8 @@ The name of the function or case is included between the braces." "List of contexts where auto lineup of :'s or ='s should be done. Elements can be of type: `paramlist', `declaration' or `case', which will do auto lineup in parameterlist, declarations or case-statements -respectively. The word `all' will do all lineups. '(case paramlist) for -instance will do lineup in case-statements and parameterlist, while '(all) +respectively. The word `all' will do all lineups. (case paramlist) for +instance will do lineup in case-statements and parameterlist, while (all) will do all lineups." :type '(set :extra-offset 8 (const :tag "Everything" all) diff --git a/lisp/progmodes/python.el b/lisp/progmodes/python.el index 20efc5e2b0a..04542cdff3d 100644 --- a/lisp/progmodes/python.el +++ b/lisp/progmodes/python.el @@ -485,7 +485,7 @@ The type returned can be `comment', `string' or `paren'." ((nth 1 ppss) 'paren)))) (defsubst python-syntax-comment-or-string-p (&optional ppss) - "Return non-nil if PPSS is inside 'comment or 'string." + "Return non-nil if PPSS is inside comment or string." (nth 8 (or ppss (syntax-ppss)))) (defsubst python-syntax-closing-paren-p () @@ -1842,7 +1842,7 @@ This command assumes point is not in a string or comment." (defun python-nav-if-name-main () "Move point at the beginning the __main__ block. -When \"if __name__ == '__main__':\" is found returns its +When \"if __name__ == \\='__main__\\=':\" is found returns its position, else returns nil." (interactive) (let ((point (point)) @@ -3051,7 +3051,7 @@ the python shell: (defun python-shell-send-region (start end &optional send-main msg) "Send the region delimited by START and END to inferior Python process. When optional argument SEND-MAIN is non-nil, allow execution of -code inside blocks delimited by \"if __name__== '__main__':\". +code inside blocks delimited by \"if __name__== \\='__main__\\=':\". When called interactively SEND-MAIN defaults to nil, unless it's called with prefix argument. When optional argument MSG is non-nil, forces display of a user-friendly message if there's no @@ -3068,7 +3068,7 @@ process running; defaults to t when called interactively." (defun python-shell-send-buffer (&optional send-main msg) "Send the entire buffer to inferior Python process. When optional argument SEND-MAIN is non-nil, allow execution of -code inside blocks delimited by \"if __name__== '__main__':\". +code inside blocks delimited by \"if __name__== \\='__main__\\=':\". When called interactively SEND-MAIN defaults to nil, unless it's called with prefix argument. When optional argument MSG is non-nil, forces display of a user-friendly message if there's no diff --git a/lisp/progmodes/sh-script.el b/lisp/progmodes/sh-script.el index baed27bb138..ac512f607aa 100644 --- a/lisp/progmodes/sh-script.el +++ b/lisp/progmodes/sh-script.el @@ -1450,7 +1450,7 @@ This is for the rc shell." (defun sh-mkword-regexpr (word) "Make a regexp which matches WORD as a word. This specifically excludes an occurrence of WORD followed by -punctuation characters like '-'." +punctuation characters like `-'." (concat word "\\([^-[:alnum:]_]\\|$\\)")) (defconst sh-re-done (sh-mkword-regexpr "done")) diff --git a/lisp/progmodes/simula.el b/lisp/progmodes/simula.el index bc0133805ee..d3ee9b5b4b2 100644 --- a/lisp/progmodes/simula.el +++ b/lisp/progmodes/simula.el @@ -344,22 +344,22 @@ Variables controlling indentation style: with respect to the previous line of the statement. `simula-label-offset' -4711 Offset of SIMULA label lines relative to usual indentation. - `simula-if-indent' '(0 . 0) + `simula-if-indent' (0 . 0) Extra indentation of THEN and ELSE with respect to the starting IF. Value is a cons cell, the car is extra THEN indentation and the cdr extra ELSE indentation. IF after ELSE is indented as the starting IF. - `simula-inspect-indent' '(0 . 0) + `simula-inspect-indent' (0 . 0) Extra indentation of WHEN and OTHERWISE with respect to the corresponding INSPECT. Value is a cons cell, the car is extra WHEN indentation and the cdr extra OTHERWISE indentation. `simula-electric-indent' nil If this variable is non-nil, `simula-indent-line' will check the previous line to see if it has to be reindented. - `simula-abbrev-keyword' 'upcase + `simula-abbrev-keyword' `upcase' Determine how SIMULA keywords will be expanded. Value is one of the symbols `upcase', `downcase', `capitalize', (as in) `abbrev-table', or nil if they should not be changed. - `simula-abbrev-stdproc' 'abbrev-table + `simula-abbrev-stdproc' `abbrev-table' Determine how standard SIMULA procedure and class names will be expanded. Value is one of the symbols `upcase', `downcase', `capitalize', (as in) `abbrev-table', or nil if they should not be changed. diff --git a/lisp/progmodes/sql.el b/lisp/progmodes/sql.el index abc99eec909..40596749de7 100644 --- a/lisp/progmodes/sql.el +++ b/lisp/progmodes/sql.el @@ -2987,7 +2987,7 @@ supported: :number t In order to ask the user for username, password and database, call the -function like this: (sql-get-login 'user 'password 'database)." +function like this: (sql-get-login \\='user \\='password \\='database)." (dolist (w what) (let ((plist (cdr-safe w))) (pcase (or (car-safe w) w) @@ -4891,7 +4891,7 @@ your might try undecided-dos as a coding system. If this doesn't help, Try to set `comint-output-filter-functions' like this: \(setq comint-output-filter-functions (append comint-output-filter-functions - '(comint-strip-ctrl-m))) + \\='(comint-strip-ctrl-m))) \(Type \\[describe-mode] in the SQL buffer for a list of commands.)" (interactive "P") diff --git a/lisp/progmodes/vera-mode.el b/lisp/progmodes/vera-mode.el index bce56a447f0..354002dd3b3 100644 --- a/lisp/progmodes/vera-mode.el +++ b/lisp/progmodes/vera-mode.el @@ -870,7 +870,7 @@ This function does not modify point or mark." (beginning-of-line))))))) (defmacro vera-prepare-search (&rest body) - "Execute BODY with a syntax table that includes '_'." + "Execute BODY with a syntax table that includes `_'." `(with-syntax-table vera-mode-ext-syntax-table ,@body)) ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; diff --git a/lisp/progmodes/verilog-mode.el b/lisp/progmodes/verilog-mode.el index 489094b2e4f..eae2f6cb8a6 100644 --- a/lisp/progmodes/verilog-mode.el +++ b/lisp/progmodes/verilog-mode.el @@ -750,7 +750,7 @@ Set this to \"logic\" for SystemVerilog code, or use `verilog-auto-logic'." (put 'verilog-auto-wire-type 'safe-local-variable `stringp) (defcustom verilog-auto-endcomments t - "Non-nil means insert a comment /* ... */ after 'end's. + "Non-nil means insert a comment /* ... */ after `end's. The name of the function or case will be set between the braces." :group 'verilog-mode-actions :type 'boolean) @@ -790,7 +790,7 @@ needed on every save. A value of `detect' will do \\[verilog-auto] automatically when it thinks necessary. A value of `ask' will query the user when it thinks updating is needed. -You should not rely on the 'ask or 'detect policies, they are safeguards +You should not rely on the `ask' or `detect' policies, they are safeguards only. They do not detect when AUTOINSTs need to be updated because a sub-module's port list has changed." :group 'verilog-mode-actions @@ -3717,12 +3717,12 @@ Variables controlling indentation/edit style: will be inserted. Setting this variable to zero results in every end acquiring a comment; the default avoids too many redundant comments in tight quarters. - `verilog-auto-lineup' (default 'declarations) + `verilog-auto-lineup' (default `declarations') List of contexts where auto lineup of code should be done. Variables controlling other actions: - `verilog-linter' (default surelint) + `verilog-linter' (default `surelint') Unix program to call to run the lint checker. This is the default command for \\[compile-command] and \\[verilog-auto-save-compile]. @@ -4073,7 +4073,7 @@ The upper left corner is defined by point. Indices begin with 0 and extend to the MAX - 1. If no prefix arg is given, the user is prompted for a value. The indices are surrounded by square brackets []. For example, the following code with the point -located after the first 'a' gives: +located after the first `a' gives: a = b a[ 0] = b a = b a[ 1] = b @@ -12899,7 +12899,7 @@ used on the right hand side of assignments. By default, AUTORESET will include the width of the signal in the autos, SystemVerilog designs may want to change this. To control this behavior, see `verilog-auto-reset-widths'. In some cases -AUTORESET must use a '0 assignment and it will print NOWIDTH; use +AUTORESET must use a \\='0 assignment and it will print NOWIDTH; use `verilog-auto-reset-widths' unbased to prevent this. AUTORESET ties signals to deasserted, which is presumed to be zero. diff --git a/lisp/progmodes/vhdl-mode.el b/lisp/progmodes/vhdl-mode.el index 9ee4ab520e1..09330d76dcd 100644 --- a/lisp/progmodes/vhdl-mode.el +++ b/lisp/progmodes/vhdl-mode.el @@ -585,7 +585,7 @@ option `vhdl-file-header'). The default directory must have an absolute path (use `M-TAB' for completion). All other paths can be absolute or relative to the default directory. All -paths must end with '/'. +paths must end with `/'. The design units found in the sources (files and directories) are shown in the hierarchy browser. Path and file name can contain wildcards `*' and `?' as @@ -945,7 +945,7 @@ If nil, only a list of actual parameters is entered." :group 'vhdl-template) (defcustom vhdl-sensitivity-list-all t - "Non-nil means use 'all' keyword in sensitivity list." + "Non-nil means use `all' keyword in sensitivity list." :version "25.1" :type 'boolean :group 'vhdl-template) @@ -1103,7 +1103,7 @@ Otherwise, falling edge triggers." (defcustom vhdl-clock-edge-condition 'standard "Syntax of the clock edge condition. - Standard: \"clk'event and clk = '1'\" + Standard: \"clk\\='event and clk = \\='1\\='\" Function: \"rising_edge(clk)\"" :type '(choice (const :tag "Standard" standard) (const :tag "Function" function)) @@ -2477,7 +2477,7 @@ current buffer if no project is defined." default-directory)) (defmacro vhdl-prepare-search-1 (&rest body) - "Enable case insensitive search and switch to syntax table that includes '_', + "Enable case insensitive search and switch to syntax table that includes `_', then execute BODY, and finally restore the old environment. Used for consistent searching." `(let ((case-fold-search t)) ; case insensitive search @@ -2486,7 +2486,7 @@ consistent searching." ,@body))) (defmacro vhdl-prepare-search-2 (&rest body) - "Enable case insensitive search, switch to syntax table that includes '_', + "Enable case insensitive search, switch to syntax table that includes `_', arrange to ignore `intangible' overlays, then execute BODY, and finally restore the old environment. Used for consistent searching." `(let ((case-fold-search t) ; case insensitive search @@ -2759,7 +2759,7 @@ elements > `vhdl-menu-max-size'." (defun vhdl-function-name (prefix string &optional postfix) "Generate a Lisp function name. -PREFIX, STRING and optional POSTFIX are concatenated by '-' and spaces in +PREFIX, STRING and optional POSTFIX are concatenated by `-' and spaces in STRING are replaced by `-' and substrings are converted to lower case." (let ((name prefix)) (while (string-match "\\(\\w+\\)\\s-*\\(.*\\)" string) @@ -8189,8 +8189,8 @@ options vhdl-upper-case-{keywords,types,attributes,enum-values}." (defun vhdl-fix-statement-region (beg end &optional arg) "Force statements in region on separate line except when on same line -with 'end' keyword (necessary for correct indentation). -Currently supported keywords: 'begin', 'if'." +with `end' keyword (necessary for correct indentation). +Currently supported keywords: `begin', `if'." (interactive "r\nP") (vhdl-prepare-search-2 (let (point) @@ -8236,7 +8236,7 @@ Currently supported keywords: 'begin', 'if'." (defun vhdl-fix-statement-buffer () "Force statements in buffer on separate line except when on same line -with 'end' keyword (necessary for correct indentation)." +with `end' keyword (necessary for correct indentation)." (interactive) (vhdl-fix-statement-region (point-min) (point-max))) @@ -10578,22 +10578,22 @@ specification, if not already there." (insert "-- pragma " directive)) (defun vhdl-template-directive-translate-on () - "Insert directive 'translate_on'." + "Insert directive `translate_on'." (interactive) (vhdl-template-directive "translate_on")) (defun vhdl-template-directive-translate-off () - "Insert directive 'translate_off'." + "Insert directive `translate_off'." (interactive) (vhdl-template-directive "translate_off")) (defun vhdl-template-directive-synthesis-on () - "Insert directive 'synthesis_on'." + "Insert directive `synthesis_on'." (interactive) (vhdl-template-directive "synthesis_on")) (defun vhdl-template-directive-synthesis-off () - "Insert directive 'synthesis_off'." + "Insert directive `synthesis_off'." (interactive) (vhdl-template-directive "synthesis_off")) @@ -13307,7 +13307,7 @@ File statistics: \"%s\"\n\ (defconst vhdl-font-lock-syntactic-keywords '(("\\('\\).\\('\\)" (1 (7 . ?\')) (2 (7 . ?\')))) - "Mark single quotes as having string quote syntax in 'c' instances.") + "Mark single quotes as having string quote syntax in `c' instances.") (defvar vhdl-font-lock-keywords nil "Regular expressions to highlight in VHDL Mode.") @@ -17760,7 +17760,7 @@ Release Notes for VHDL Mode 3.37 - Context declaration - Block comments - Directives - - 'all' keyword in sensitivity list + - `all' keyword in sensitivity list Release Notes for VHDL Mode 3.34 |