mirrors/emacs
1
Fork 0
mirror of git://git.sv.gnu.org/emacs.git synced 2025-12-06 06:20:55 -08:00
Code Issues Projects Releases Wiki Activity

New user option checkdoc-arguments-missing-flag

Browse source 
* lisp/emacs-lisp/checkdoc.el
(checkdoc-arguments-missing-flag): New user option.
(checkdoc-this-string-valid-engine): Use above new option.
(checkdoc--argument-missing-flag): Make into obsolete variable alias for
above new option.
This commit is contained in:
Stefan Kangas 2025-03-06 00:33:21 +01:00
parent fac9097b16
commit 679966b5a0
2 changed files with 14 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -353,19 +353,19 @@ See Info node `(elisp) Documentation Tips' for background."
;; This is how you can use checkdoc to make mass fixes on the Emacs
;; source tree:
;;
;; (setq checkdoc--argument-missing-flag nil) ; optional
;; (setq checkdoc-arguments-missing-flag nil) ; optional
;; (setq checkdoc--disambiguate-symbol-flag nil) ; optional
;; (setq checkdoc--interactive-docstring-flag nil) ; optional
;; (setq checkdoc-permit-comma-termination-flag t) ; optional
;; (setq checkdoc-verb-check-experimental-flag nil)
;; Then use `M-x find-dired' ("-name '*.el'") and `M-x checkdoc-dired'
(defvar checkdoc--argument-missing-flag t
"Non-nil means warn if arguments are missing from docstring.
This variable is intended for use on Emacs itself, where the
large number of libraries means it is impractical to fix all
of these warnings en masse. In almost any other case, setting
this to anything but t is likely to be counter-productive.")
(define-obsolete-variable-alias 'checkdoc--argument-missing-flag
'checkdoc-arguments-missing-flag "31.1")
(defcustom checkdoc-arguments-missing-flag t
"Non-nil means warn if function arguments are missing from docstring."
:type 'boolean
:version "31.1")
;;;###autoload(put 'checkdoc-arguments-missing-flag 'safe-local-variable 'booleanp)
(defvar checkdoc--disambiguate-symbol-flag t
"Non-nil means ask to disambiguate Lisp symbol.
@ -1852,7 +1852,7 @@ function,command,variable,option or symbol." ms1))))))
(looking-at "[.?!]")))
(insert "."))
nil)
(when checkdoc--argument-missing-flag
(when checkdoc-arguments-missing-flag
(checkdoc-create-error
(format-message
"Argument `%s' should appear (as %s) in the doc string"