]> git.eshelyaron.com Git - emacs.git/commitdiff
Reword a long docstring in cc-langs.el
authorBasil L. Contovounesios <contovob@tcd.ie>
Tue, 29 Dec 2020 01:19:07 +0000 (01:19 +0000)
committerBasil L. Contovounesios <contovob@tcd.ie>
Tue, 29 Dec 2020 01:23:14 +0000 (01:23 +0000)
* lisp/progmodes/cc-langs.el (c-vsemi-status-unknown-p-fn): Reword
docstring to fit within 80 columns and silence the corresponding
byte-compiler warning (bug#44858).

lisp/progmodes/cc-langs.el

index 9b13cedc9880fcef8685a4bcb3fbbad8c0fc84f9..b10a085552d2801ae3d5e6ca1237926051152be0 100644 (file)
@@ -581,12 +581,14 @@ don't have EOL terminated statements. "
 (c-lang-defvar c-at-vsemi-p-fn (c-lang-const c-at-vsemi-p-fn))
 
 (c-lang-defconst c-vsemi-status-unknown-p-fn
-  "Contains a function \"are we unsure whether there is a virtual semicolon on this line?\".
-The (admittedly kludgy) purpose of such a function is to prevent an infinite
-recursion in c-beginning-of-statement-1 when point starts at a `while' token.
-The function MUST NOT UNDER ANY CIRCUMSTANCES call c-beginning-of-statement-1,
-even indirectly.  This variable contains nil for languages which don't have
-EOL terminated statements."
+  "Contains a predicate regarding the presence of virtual semicolons.
+More precisely, the function answers the question, \"are we unsure whether a
+virtual semicolon exists on this line?\".  The (admittedly kludgy) purpose of
+such a function is to prevent an infinite recursion in
+`c-beginning-of-statement-1' when point starts at a `while' token.  The function
+MUST NOT UNDER ANY CIRCUMSTANCES call `c-beginning-of-statement-1', even
+indirectly.  This variable contains nil for languages which don't have EOL
+terminated statements."
   t nil
   (c c++ objc) 'c-macro-vsemi-status-unknown-p
   awk 'c-awk-vsemi-status-unknown-p)