Don't hardcode "Commentary" section in checkdoc

* 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.

diff --git a/lisp/emacs-lisp/checkdoc.el b/lisp/emacs-lisp/checkdoc.el
index e03ddc4c666fb97a26496df1768fbcc3a0abca16..1ed210215a1e1731683e4f215c0cc3dd25398e0c 100644 (file)
--- a/lisp/emacs-lisp/checkdoc.el
+++ b/lisp/emacs-lisp/checkdoc.el
@@ -339,6 +339,7 @@ See Info node `(elisp) Documentation Tips' for background."
 ;; (setq checkdoc--argument-missing-flag nil)      ; optional
 ;; (setq checkdoc--disambiguate-symbol-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'
 
 (defvar checkdoc--argument-missing-flag t
@@ -493,6 +494,9 @@ be re-created.")
 (defconst checkdoc--help-buffer "*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
 ;;
 ;;;###autoload
@@ -2410,7 +2414,7 @@ Code:, and others referenced in the style guide."
                  nil nil t)))
              (if (checkdoc-y-or-n-p
                    "You should have a \";;; Commentary:\", add one?")
-                 (insert "\n;;; Commentary:\n;; \n\n")
+                  (insert checkdoc-commentary-header-string)
                (checkdoc-create-error
                 "You should have a section marked \";;; Commentary:\""
                 nil nil t)))