summaryrefslogtreecommitdiff
path: root/lisp/emacs-lisp/checkdoc.el
diff options
context:
space:
mode:
authorStefan Kangas <stefan@marxist.se>2021-09-18 11:24:22 +0200
committerStefan Kangas <stefan@marxist.se>2021-09-18 11:24:31 +0200
commitc1356d3a05a789555c327dd4cb0f444fdf7be205 (patch)
tree53fe6a2530e3b40f25e0cd097afb424279b5dcc8 /lisp/emacs-lisp/checkdoc.el
parent00b6a56f0a04110105977027f1af0f7410650c47 (diff)
downloademacs-c1356d3a05a789555c327dd4cb0f444fdf7be205.tar.gz
emacs-c1356d3a05a789555c327dd4cb0f444fdf7be205.tar.bz2
emacs-c1356d3a05a789555c327dd4cb0f444fdf7be205.zip
* lisp/emacs-lisp/checkdoc.el: Doc fix; mention flymake.
Diffstat (limited to 'lisp/emacs-lisp/checkdoc.el')
-rw-r--r--lisp/emacs-lisp/checkdoc.el7
1 files changed, 4 insertions, 3 deletions
diff --git a/lisp/emacs-lisp/checkdoc.el b/lisp/emacs-lisp/checkdoc.el
index 4c8117ccf3b..3ed489f32e8 100644
--- a/lisp/emacs-lisp/checkdoc.el
+++ b/lisp/emacs-lisp/checkdoc.el
@@ -29,11 +29,12 @@
;; to forget. The main checkdoc engine will perform the stylistic
;; checks needed to make sure these styles are remembered.
;;
-;; There are two ways to use checkdoc:
-;; 1) Periodically use `checkdoc' or `checkdoc-current-buffer'.
+;; There are three ways to use checkdoc:
+;; 1) Use `flymake-mode'.
+;; 2) Periodically use `checkdoc' or `checkdoc-current-buffer'.
;; `checkdoc' is a more interactive version of
;; `checkdoc-current-buffer'
-;; 2) Use `checkdoc-minor-mode' to automatically check your
+;; 3) Use `checkdoc-minor-mode' to automatically check your
;; documentation whenever you evaluate Lisp code with C-M-x
;; or [menu-bar emacs-lisp eval-buffer]. Additional key-bindings
;; are also provided under C-c ? KEY