procyberian/emacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

(checkdoc-this-string-valid-engine):

Browse source 
Don't encourage naming variables with "-flag".
This commit is contained in:
Stefan Monnier 2008-05-30 14:51:48 +00:00
parent a266686a02
commit 145b63776b
2 changed files with 26 additions and 18 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
lisp/ChangeLog
View file

@ -1,3 +1,8 @@
2008-05-30 Stefan Monnier <monnier@iro.umontreal.ca>
* emacs-lisp/checkdoc.el (checkdoc-this-string-valid-engine):
Don't encourage naming variables with "-flag".
2008-05-30 Glenn Morris <rgm@gnu.org>
* Makefile.in (update-elclist): Hide the warning when it does not apply,

39
lisp/emacs-lisp/checkdoc.el
View file

@ -1636,25 +1636,28 @@ function,command,variable,option or symbol." ms1))))))
(checkdoc-create-error
"Flag variable doc strings should usually start: Non-nil means"
s (marker-position e) t))
;; Don't rename variable to "foo-flag". This is unnecessary
;; and such names often end up inconvenient when the variable
;; is later expanded to non-boolean values. --Stef
;; If the doc string starts with "Non-nil means"
(if (and (looking-at "\"\\*?Non-nil\\s-+means\\s-+")
(not (string-match "-flag$" (car fp))))
(let ((newname
(if (string-match "-p$" (car fp))
(concat (substring (car fp) 0 -2) "-flag")
(concat (car fp) "-flag"))))
(if (checkdoc-y-or-n-p
(format
"Rename to %s and Query-Replace all occurrences? "
newname))
(progn
(beginning-of-defun)
(query-replace-regexp
(concat "\\<" (regexp-quote (car fp)) "\\>")
newname))
(checkdoc-create-error
"Flag variable names should normally end in `-flag'" s
(marker-position e)))))
;; (if (and (looking-at "\"\\*?Non-nil\\s-+means\\s-+")
;; (not (string-match "-flag$" (car fp))))
;; (let ((newname
;; (if (string-match "-p$" (car fp))
;; (concat (substring (car fp) 0 -2) "-flag")
;; (concat (car fp) "-flag"))))
;; (if (checkdoc-y-or-n-p
;; (format
;; "Rename to %s and Query-Replace all occurrences? "
;; newname))
;; (progn
;; (beginning-of-defun)
;; (query-replace-regexp
;; (concat "\\<" (regexp-quote (car fp)) "\\>")
;; newname))
;; (checkdoc-create-error
;; "Flag variable names should normally end in `-flag'" s
;; (marker-position e)))))
;; Done with variables
))
(t