From fc3da97aa516c5a487a470527ce2999866c76007 Mon Sep 17 00:00:00 2001 From: Stefan Kangas Date: Mon, 8 Jul 2024 14:30:37 +0200 Subject: [PATCH] Checkdoc fixes in `emacs-lisp/*.el` * lisp/emacs-lisp/bytecomp.el (byte-compile-free-vars-warn) (byte-compile-out): * lisp/emacs-lisp/eldoc.el (eldoc-documentation-functions): * lisp/emacs-lisp/find-func.el (find-ert-deftest-regexp): * lisp/emacs-lisp/macroexp.el (byte-compile-form-stack): Checkdoc fixes. (cherry picked from commit ef7364b070e416810de0861c78dbdedf183ee067) --- lisp/emacs-lisp/bytecomp.el | 4 ++-- lisp/emacs-lisp/eldoc.el | 2 +- lisp/emacs-lisp/find-func.el | 2 +- lisp/emacs-lisp/macroexp.el | 2 +- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/lisp/emacs-lisp/bytecomp.el b/lisp/emacs-lisp/bytecomp.el index 94f5264cb6a..569bd7f03f7 100644 --- a/lisp/emacs-lisp/bytecomp.el +++ b/lisp/emacs-lisp/bytecomp.el @@ -3840,7 +3840,7 @@ This assumes the function has the `important-return-value' property." (defun byte-compile-free-vars-warn (arg var &optional assignment) "Warn if symbol VAR refers to a free variable. VAR must not be lexically bound. -ARG is a position argument, used by byte-compile-warn-x. +ARG is a position argument, used by `byte-compile-warn-x'. If optional argument ASSIGNMENT is non-nil, this is treated as an assignment (i.e. `setq')." (unless (or (not (byte-compile-warning-enabled-p 'free-vars var)) @@ -5496,7 +5496,7 @@ OP and OPERAND are as passed to `byte-compile-out'." (defun byte-compile-out (op &optional operand) "Push the operation onto `byte-compile-output'. OP is an opcode, a symbol. OPERAND is either nil or a number or -a one-element list of a lisp form." +a one-element list of a Lisp form." (when (and (consp operand) (null (cdr operand))) (setq operand (byte-run-strip-symbol-positions operand))) (push (cons op operand) byte-compile-output) diff --git a/lisp/emacs-lisp/eldoc.el b/lisp/emacs-lisp/eldoc.el index 1a7dad4e026..b3fcd43328b 100644 --- a/lisp/emacs-lisp/eldoc.el +++ b/lisp/emacs-lisp/eldoc.el @@ -462,7 +462,7 @@ documentation-displaying frontends. For example, KEY can be: The additional KEY `:origin' is always added by ElDoc, its VALUE being the member of `eldoc-documentation-functions' where -DOCSTRING originated. `eldoc-display-functions' may use this +DOCSTRING originated. `eldoc-display-functions' may use this information to organize display of multiple docstrings. Finally, major modes should modify this hook locally, for diff --git a/lisp/emacs-lisp/find-func.el b/lisp/emacs-lisp/find-func.el index 3e46a6522b4..4753f8362e6 100644 --- a/lisp/emacs-lisp/find-func.el +++ b/lisp/emacs-lisp/find-func.el @@ -125,7 +125,7 @@ should insert the feature name." (defcustom find-ert-deftest-regexp "(ert-deftest +'%s" - "The regexp used to search for an ert-deftest definition. + "The regexp used to search for an `ert-deftest' definition. Note it must contain a `%s' at the place where `format' should insert the feature name." :type 'regexp diff --git a/lisp/emacs-lisp/macroexp.el b/lisp/emacs-lisp/macroexp.el index bb4797cac8b..4524eccc7ef 100644 --- a/lisp/emacs-lisp/macroexp.el +++ b/lisp/emacs-lisp/macroexp.el @@ -37,7 +37,7 @@ most deeply nested form. Normally a form is manually pushed onto the list at the beginning of `byte-compile-form', etc., and manually popped off at its end. This is to preserve the data in it in the event of a -condition-case handling a signaled error.") +`condition-case' handling a signaled error.") (defmacro macroexp--with-extended-form-stack (expr &rest body) "Evaluate BODY with EXPR pushed onto `byte-compile-form-stack'." -- 2.39.2