Checkdoc fixes in `emacs-lisp/*.el`
authorStefan Kangas <stefankangas@gmail.com>
Mon, 8 Jul 2024 12:30:37 +0000 (14:30 +0200)
committerStefan Kangas <stefankangas@gmail.com>
Mon, 8 Jul 2024 12:30:37 +0000 (14:30 +0200)
* 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.

lisp/emacs-lisp/bytecomp.el
lisp/emacs-lisp/eldoc.el
lisp/emacs-lisp/find-func.el
lisp/emacs-lisp/macroexp.el

index d59e89bd7dede93c5fd14342a55dfe77e12c99fc..88167fc7ebd8086f7cd93c3dd355f882dd0b4665 100644 (file)
@@ -3832,7 +3832,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))
@@ -5488,7 +5488,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)
index 24afd03fbe6b373738d1662e9238e46e772c8089..417c0145be48d2b2359b915e7227e6636314e5d4 100644 (file)
@@ -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
index 411602ef166897dc475f51e83789770899278549..ce783983b77488473e419be9f121f7ecf0b7f451 100644 (file)
@@ -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
index bb4797cac8b18b584ebb52e373255b2070f5bfc8..4524eccc7ef8b5a0e7282ba25ac9cb8d0ca5ec98 100644 (file)
@@ -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'."