summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPhilipp Stephani <phst@google.com>2020-05-08 22:12:07 +0200
committerPhilipp Stephani <phst@google.com>2020-05-08 22:12:07 +0200
commita1cbd05f3892fc86815f69bc50d8ab9175b7b082 (patch)
tree52005b1889e001d3f90e40572877ad58d0be0ea1
parent4a895c1b2601150357d6523bb5121fb07a89701e (diff)
downloademacs-a1cbd05f3892fc86815f69bc50d8ab9175b7b082.tar.gz
Improve documentation of 'with-suppressed-warnings'.
* lisp/emacs-lisp/byte-run.el (with-suppressed-warnings): Refer to 'byte-compile-warnings' instead of 'byte-compile-warning-types', as only the former variable documents the available warning types.
-rw-r--r--lisp/emacs-lisp/byte-run.el11
1 files changed, 6 insertions, 5 deletions
diff --git a/lisp/emacs-lisp/byte-run.el b/lisp/emacs-lisp/byte-run.el
index 6a49c60099d..70fe06085dc 100644
--- a/lisp/emacs-lisp/byte-run.el
+++ b/lisp/emacs-lisp/byte-run.el
@@ -513,11 +513,12 @@ wrong number of parameters, say
(zot 1 2))
The warnings that can be suppressed are a subset of the warnings
-in `byte-compile-warning-types'; see this variable for a fuller
-explanation of the warning types. The types that can be
-suppressed with this macro are `free-vars', `callargs',
-`redefine', `obsolete', `interactive-only', `lexical', `mapcar',
-`constants' and `suspicious'.
+in `byte-compile-warning-types'; see the variable
+`byte-compile-warnings' for a fuller explanation of the warning
+types. The types that can be suppressed with this macro are
+`free-vars', `callargs', `redefine', `obsolete',
+`interactive-only', `lexical', `mapcar', `constants' and
+`suspicious'.
For the `mapcar' case, only the `mapcar' function can be used in
the symbol list. For `suspicious', only `set-buffer' can be used."