summaryrefslogtreecommitdiff
path: root/lisp/emacs-lisp
diff options
context:
space:
mode:
authorPo Lu <luangruo@yahoo.com>2022-12-11 09:34:03 +0800
committerPo Lu <luangruo@yahoo.com>2022-12-11 09:34:03 +0800
commit5737c2a3af70bc8d653abdb22922c4dc2a49e878 (patch)
tree4e718cb78d35766fb2b7ff7f7cc96fa575db53f6 /lisp/emacs-lisp
parent52de8885048daf444bdbdb34c4b3d0318dc6a76c (diff)
parent79659416f95ac986812a8b40c1260907b95aaa0b (diff)
downloademacs-5737c2a3af70bc8d653abdb22922c4dc2a49e878.tar.gz
emacs-5737c2a3af70bc8d653abdb22922c4dc2a49e878.tar.bz2
emacs-5737c2a3af70bc8d653abdb22922c4dc2a49e878.zip
Merge from origin/emacs-29
79659416f95 ; * admin/git-bisect-start: Fix commit hash a9037aa8e81 ; Fix use-package-ensure-system-package macOS footnote 7d787564c08 Actually improve detection of long lines 118465f6fed ; Improve checkdoc.el commentary section 30e3cb21351 Unset the weight/slant/width in the spec when realizing a... 01154166057 Update to Org 9.6-31-g954a95 26a8644a587 ; tabulated-list.el: Remove duplicate obsolete declaration 29b9aeae32a ; * doc/misc/use-package.texi: Fix misplaced @end group. 3c5a41b2008 ; * doc/lispref/keymaps.texi (Searching Keymaps): Fix a t... 1753da24cd4 Fix infloop in 'shell-resync-dirs' with tcsh 2f1269c3331 ; Fix some minor issues in use-package.texi
Diffstat (limited to 'lisp/emacs-lisp')
-rw-r--r--lisp/emacs-lisp/checkdoc.el25
-rw-r--r--lisp/emacs-lisp/tabulated-list.el2
2 files changed, 17 insertions, 10 deletions
diff --git a/lisp/emacs-lisp/checkdoc.el b/lisp/emacs-lisp/checkdoc.el
index 3bddb93b64a..26d87a3622d 100644
--- a/lisp/emacs-lisp/checkdoc.el
+++ b/lisp/emacs-lisp/checkdoc.el
@@ -22,28 +22,35 @@
;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
;;; Commentary:
-;;
+
;; The Emacs Lisp manual has a nice chapter on how to write
;; documentation strings. Many stylistic suggestions are fairly
;; deterministic and easy to check for syntactically, but also easy
;; to forget. The main checkdoc engine will perform the stylistic
;; checks needed to make sure these styles are remembered.
;;
-;; There are three ways to use checkdoc:
-;; 1) Use `flymake-mode'.
+;; There are four ways to use checkdoc:
+;;
+;; 1) Use `flymake-mode'. Type `M-x flymake-mode' in any Emacs Lisp
+;; buffer; the checkdoc back-end is enabled by default.
+;;
;; 2) Periodically use `checkdoc' or `checkdoc-current-buffer'.
-;; `checkdoc' is a more interactive version of
-;; `checkdoc-current-buffer'
+;; The `checkdoc' command is a more interactive version of
+;; `checkdoc-current-buffer'.
+;;
;; 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
;; (add-hook 'emacs-lisp-mode-hook 'checkdoc-minor-mode)
;;
+;; 4) Use `checkdoc-ispell' to spellcheck docstrings interactively.
+;;
;; Using `checkdoc':
;;
-;; The commands `checkdoc' and `checkdoc-ispell' are the top-level
-;; entry points to all of the different checks that are available. It
+;; Most users will probably use checkdoc through `flymake'. The
+;; commands `checkdoc' and `checkdoc-ispell' are the top-level entry
+;; points to all of the different checks that are available. It
;; breaks examination of your Lisp file into four sections (comments,
;; documentation, messages, and spacing) and indicates its current
;; state in a status buffer.
@@ -66,7 +73,7 @@
;; interface offers several options, including the ability to skip to
;; the next error, or back up to previous errors. Auto-fixing is
;; turned off at this stage, but you can use the `f' or `F' key to fix
-;; a given error (if the fix is available.)
+;; a given error (if the fix is available).
;;
;; Auto-fixing:
;;
@@ -99,6 +106,7 @@
;; install into Ispell on the fly, but only if Ispell is not already
;; running. Use `ispell-kill-ispell' to make checkdoc restart it with
;; these words enabled.
+;; See also the `flyspell-prog-mode' minor mode.
;;
;; Checking parameters:
;;
@@ -176,6 +184,7 @@
"Support for doc string checking in Emacs Lisp."
:prefix "checkdoc"
:group 'lisp
+ :link '(emacs-commentary-link "checkdoc.el")
:version "20.3")
(defcustom checkdoc-minor-mode-string " CDoc"
diff --git a/lisp/emacs-lisp/tabulated-list.el b/lisp/emacs-lisp/tabulated-list.el
index 206c10a7734..595dc9b29db 100644
--- a/lisp/emacs-lisp/tabulated-list.el
+++ b/lisp/emacs-lisp/tabulated-list.el
@@ -263,8 +263,6 @@ Populated by `tabulated-list-init-header'.")
'header-line-indent--line-number-width "29.1")
(define-obsolete-function-alias 'tabulated-list-watch-line-number-width
'header-line-indent--watch-line-number-width "29.1")
-(define-obsolete-function-alias 'tabulated-list-watch-line-number-width
- 'header-line-indent--watch-line-number-width "29.1")
(define-obsolete-function-alias 'tabulated-list-window-scroll-function
'header-line-indent--window-scroll-function "29.1")