diff options
| author | Stefan Kangas <stefan@marxist.se> | 2021-11-05 22:31:17 +0100 |
|---|---|---|
| committer | Stefan Kangas <stefan@marxist.se> | 2021-11-05 22:31:17 +0100 |
| commit | 49a6b26cf7b9ed91c319b9cf215d347e1f9f155a (patch) | |
| tree | 40a5fe0492bfb7500aec409355fe852d7c38431f /lisp/emacs-lisp | |
| parent | c5adec394ad1b50e1ab3da6f384019be3e5c764b (diff) | |
| download | emacs-49a6b26cf7b9ed91c319b9cf215d347e1f9f155a.tar.gz emacs-49a6b26cf7b9ed91c319b9cf215d347e1f9f155a.tar.bz2 emacs-49a6b26cf7b9ed91c319b9cf215d347e1f9f155a.zip | |
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.
Diffstat (limited to 'lisp/emacs-lisp')
| -rw-r--r-- | lisp/emacs-lisp/checkdoc.el | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/lisp/emacs-lisp/checkdoc.el b/lisp/emacs-lisp/checkdoc.el index e03ddc4c666..1ed210215a1 100644 --- 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))) |