diff options
| author | Paul Eggert | 2015-09-16 16:23:55 -0700 |
|---|---|---|
| committer | Paul Eggert | 2015-09-16 16:26:07 -0700 |
| commit | 032ce1c7d1afb23e6b1265d91c5a97e45de071ce (patch) | |
| tree | dab9ca1e540c23aeb15ee9ef8fdc6b78e1929b6d /src/eval.c | |
| parent | 309d39b832ccd72f99cc726090ff03f7e146948d (diff) | |
| download | emacs-032ce1c7d1afb23e6b1265d91c5a97e45de071ce.tar.gz emacs-032ce1c7d1afb23e6b1265d91c5a97e45de071ce.zip | |
Omit unnecessary \ before paren in C docstrings
Although \( is needed in docstrings in Elisp code, it is not needed in
docstrings in C code, since C function definitiions do not start with
a parenthesis. The backslashes made the docstrings a bit harder to
read and to format in columns. Also, some C docstrings had ( in
column 1 and this did not appear to be causing any problems. So,
simplify C docstrings by replacing \( with ( and \) with ).
Diffstat (limited to 'src/eval.c')
| -rw-r--r-- | src/eval.c | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/src/eval.c b/src/eval.c index b42f9047257..ac98ca11bd4 100644 --- a/src/eval.c +++ b/src/eval.c | |||
| @@ -705,7 +705,7 @@ If SYMBOL has a local binding, then this form affects the local | |||
| 705 | binding. This is usually not what you want. Thus, if you need to | 705 | binding. This is usually not what you want. Thus, if you need to |
| 706 | load a file defining variables, with this form or with `defconst' or | 706 | load a file defining variables, with this form or with `defconst' or |
| 707 | `defcustom', you should always load that file _outside_ any bindings | 707 | `defcustom', you should always load that file _outside_ any bindings |
| 708 | for these variables. \(`defconst' and `defcustom' behave similarly in | 708 | for these variables. (`defconst' and `defcustom' behave similarly in |
| 709 | this respect.) | 709 | this respect.) |
| 710 | 710 | ||
| 711 | The optional argument DOCSTRING is a documentation string for the | 711 | The optional argument DOCSTRING is a documentation string for the |
| @@ -1188,7 +1188,7 @@ suppresses the debugger). | |||
| 1188 | When a handler handles an error, control returns to the `condition-case' | 1188 | When a handler handles an error, control returns to the `condition-case' |
| 1189 | and it executes the handler's BODY... | 1189 | and it executes the handler's BODY... |
| 1190 | with VAR bound to (ERROR-SYMBOL . SIGNAL-DATA) from the error. | 1190 | with VAR bound to (ERROR-SYMBOL . SIGNAL-DATA) from the error. |
| 1191 | \(If VAR is nil, the handler can't access that information.) | 1191 | (If VAR is nil, the handler can't access that information.) |
| 1192 | Then the value of the last BODY form is returned from the `condition-case' | 1192 | Then the value of the last BODY form is returned from the `condition-case' |
| 1193 | expression. | 1193 | expression. |
| 1194 | 1194 | ||
| @@ -2366,7 +2366,7 @@ may be nil, a function, or a list of functions. Call each | |||
| 2366 | function in order with arguments ARGS, stopping at the first | 2366 | function in order with arguments ARGS, stopping at the first |
| 2367 | one that returns nil, and return nil. Otherwise (if all functions | 2367 | one that returns nil, and return nil. Otherwise (if all functions |
| 2368 | return non-nil, or if there are no functions to call), return non-nil | 2368 | return non-nil, or if there are no functions to call), return non-nil |
| 2369 | \(do not rely on the precise return value in this case). | 2369 | (do not rely on the precise return value in this case). |
| 2370 | 2370 | ||
| 2371 | Do not use `make-local-variable' to make a hook variable buffer-local. | 2371 | Do not use `make-local-variable' to make a hook variable buffer-local. |
| 2372 | Instead, use `add-hook' and specify t for the LOCAL argument. | 2372 | Instead, use `add-hook' and specify t for the LOCAL argument. |