diff options
author | Paul Eggert <eggert@cs.ucla.edu> | 2015-09-16 16:23:55 -0700 |
---|---|---|
committer | Paul Eggert <eggert@cs.ucla.edu> | 2015-09-16 16:26:07 -0700 |
commit | 032ce1c7d1afb23e6b1265d91c5a97e45de071ce (patch) | |
tree | dab9ca1e540c23aeb15ee9ef8fdc6b78e1929b6d /src/doc.c | |
parent | 309d39b832ccd72f99cc726090ff03f7e146948d (diff) | |
download | emacs-032ce1c7d1afb23e6b1265d91c5a97e45de071ce.tar.gz |
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/doc.c')
-rw-r--r-- | src/doc.c | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/src/doc.c b/src/doc.c index b6963d2ab0b..68d4367182d 100644 --- a/src/doc.c +++ b/src/doc.c @@ -716,7 +716,7 @@ is not on any keys. Each substring of the form \\=\\{MAPVAR} is replaced by a summary of the value of MAPVAR as a keymap. This summary is similar to the one produced by `describe-bindings'. The summary ends in two newlines -\(used by the helper function `help-make-xrefs' to find the end of the +(used by the helper function `help-make-xrefs' to find the end of the summary). Each substring of the form \\=\\<MAPVAR> specifies the use of MAPVAR |