procyberian/emacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Checkdoc fixes in emacs-lisp/*.el

Browse source 
* 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.
This commit is contained in:
Stefan Kangas 2024-07-08 14:30:37 +02:00
parent 5fe1ae0e84
commit ef7364b070
4 changed files with 5 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

4
lisp/emacs-lisp/bytecomp.el
View 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) (defun byte-compile-free-vars-warn (arg var &optional assignment)
"Warn if symbol VAR refers to a free variable. "Warn if symbol VAR refers to a free variable.
VAR must not be lexically bound. 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 If optional argument ASSIGNMENT is non-nil, this is treated as an
assignment (i.e. `setq')." assignment (i.e. `setq')."
(unless (or (not (byte-compile-warning-enabled-p 'free-vars var)) (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) (defun byte-compile-out (op &optional operand)
"Push the operation onto `byte-compile-output'. "Push the operation onto `byte-compile-output'.
OP is an opcode, a symbol. OPERAND is either nil or a number or 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))) (when (and (consp operand) (null (cdr operand)))
(setq operand (byte-run-strip-symbol-positions operand))) (setq operand (byte-run-strip-symbol-positions operand)))
(push (cons op operand) byte-compile-output) (push (cons op operand) byte-compile-output)

2
lisp/emacs-lisp/eldoc.el
View file

@ -462,7 +462,7 @@ documentation-displaying frontends. For example, KEY can be:
The additional KEY `:origin' is always added by ElDoc, its VALUE The additional KEY `:origin' is always added by ElDoc, its VALUE
being the member of `eldoc-documentation-functions' where 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. information to organize display of multiple docstrings.
Finally, major modes should modify this hook locally, for Finally, major modes should modify this hook locally, for

2
lisp/emacs-lisp/find-func.el
View file

@ -125,7 +125,7 @@ should insert the feature name."
(defcustom find-ert-deftest-regexp (defcustom find-ert-deftest-regexp
"(ert-deftest +'%s" "(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' Note it must contain a `%s' at the place where `format'
should insert the feature name." should insert the feature name."
:type 'regexp :type 'regexp

2
lisp/emacs-lisp/macroexp.el
View file

@ -37,7 +37,7 @@ most deeply nested form.
Normally a form is manually pushed onto the list at the beginning Normally a form is manually pushed onto the list at the beginning
of `byte-compile-form', etc., and manually popped off at its end. 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 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) (defmacro macroexp--with-extended-form-stack (expr &rest body)
"Evaluate BODY with EXPR pushed onto `byte-compile-form-stack'." "Evaluate BODY with EXPR pushed onto `byte-compile-form-stack'."