mirror/emacs
1
0
Fork 0
mirror of https://git.savannah.gnu.org/git/emacs.git synced 2024-12-26 10:49:33 +00:00
Code Issues Releases Activity

Make checkdoc warn about variables described as "True"

Browse Source 
* checkdoc.el (checkdoc-this-string-valid-engine): Docstrings for
variables "True...", and functions "Return true...", should usually be
"non-nil" (bug#15506).
This commit is contained in:
Kevin Ryde 2016-02-25 16:16:37 +10:30 committed by Lars Ingebrigtsen
parent 75b0a03c09
commit 80c4cfa965
1 changed files with 21 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
lisp/emacs-lisp/checkdoc.el
View File

@ -1638,6 +1638,17 @@ function,command,variable,option or symbol." ms1))))))
;; * If a user option variable records a true-or-false
;; condition, give it a name that ends in `-flag'.
;; "True ..." should be "Non-nil ..."
(when (looking-at "\"\\*?\\(True\\)\\b")
(if (checkdoc-autofix-ask-replace
(match-beginning 1) (match-end 1)
"Say \"Non-nil\" instead of \"True\"? "
"Non-nil")
nil
(checkdoc-create-error
"\"True\" should usually be \"Non-nil\""
(match-beginning 1) (match-end 1))))
;; If the variable has -flag in the name, make sure
(if (and (string-match "-flag$" (car fp))
(not (looking-at "\"\\*?Non-nil\\s-+means\\s-+")))
@ -1798,6 +1809,16 @@ Replace with \"%s\"? " original replace)
"Probably \"%s\" should be imperative \"%s\""
original replace)
(match-beginning 1) (match-end 1))))))
;; "Return true ..." should be "Return non-nil ..."
(when (looking-at "\"Return \\(true\\)\\b")
(if (checkdoc-autofix-ask-replace
(match-beginning 1) (match-end 1)
"Say \"non-nil\" instead of \"true\"? "
"non-nil")
nil
(checkdoc-create-error
"\"true\" should usually be \"non-nil\""
(match-beginning 1) (match-end 1))))
;; Done with functions
)))
;;* When a documentation string refers to a Lisp symbol, write it as