mirrors/emacs
1
Fork 0
mirror of git://git.sv.gnu.org/emacs.git synced 2026-01-04 11:00:45 -08:00
Code Issues Projects Releases Wiki Activity

Don't hardcode "Commentary" section in checkdoc

Browse source 
* lisp/emacs-lisp/checkdoc.el
(checkdoc-commentary-header-string): New defvar.
(checkdoc-file-comments-engine): Insert value of above new
variable instead of hardcoding what is inserted for the
"Commentary" section.
This commit is contained in:
Stefan Kangas 2021-11-05 22:31:17 +01:00
parent c5adec394a
commit 49a6b26cf7
1 changed files with 5 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -339,6 +339,7 @@ See Info node `(elisp) Documentation Tips' for background."
;; (setq checkdoc--argument-missing-flag nil) ; optional ;; (setq checkdoc--argument-missing-flag nil) ; optional
;; (setq checkdoc--disambiguate-symbol-flag nil) ; optional ;; (setq checkdoc--disambiguate-symbol-flag nil) ; optional
;; (setq checkdoc--interactive-docstring-flag nil) ; optional ;; (setq checkdoc--interactive-docstring-flag nil) ; optional
;; (setq checkdoc-verb-check-experimental-flag nil)
;; Then use `M-x find-dired' ("-name '*.el'") and `M-x checkdoc-dired' ;; Then use `M-x find-dired' ("-name '*.el'") and `M-x checkdoc-dired'
(defvar checkdoc--argument-missing-flag t (defvar checkdoc--argument-missing-flag t
@ -493,6 +494,9 @@ be re-created.")
(defconst checkdoc--help-buffer "*Checkdoc Help*" (defconst checkdoc--help-buffer "*Checkdoc Help*"
"Name of buffer used for Checkdoc Help.") "Name of buffer used for Checkdoc Help.")
(defvar checkdoc-commentary-header-string "\n;;; Commentary:\n;; \n\n"
"String inserted as commentary marker in `checkdoc-file-comments-engine'.")
;;; User level commands ;;; User level commands
;; ;;
;;;###autoload ;;;###autoload
@ -2410,7 +2414,7 @@ Code:, and others referenced in the style guide."
nil nil t))) nil nil t)))
(if (checkdoc-y-or-n-p (if (checkdoc-y-or-n-p
"You should have a \";;; Commentary:\", add one?") "You should have a \";;; Commentary:\", add one?")
(insert "\n;;; Commentary:\n;; \n\n") (insert checkdoc-commentary-header-string)
(checkdoc-create-error (checkdoc-create-error
"You should have a section marked \";;; Commentary:\"" "You should have a section marked \";;; Commentary:\""
nil nil t))) nil nil t)))