summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLars Ingebrigtsen <larsi@gnus.org>2019-06-09 22:24:07 +0200
committerLars Ingebrigtsen <larsi@gnus.org>2019-06-09 22:24:07 +0200
commit27b903c5fce99d3282200933e8a7fef85bb9ae37 (patch)
treefb3c2ed88af25165274dbd54d69185bcdd131b4f
parent272a22eb368f47475ad885b3c046a65f91c7d8a3 (diff)
downloademacs-27b903c5fce99d3282200933e8a7fef85bb9ae37.tar.gz
Doc touch up
-rw-r--r--lisp/emacs-lisp/byte-run.el24
1 files changed, 12 insertions, 12 deletions
diff --git a/lisp/emacs-lisp/byte-run.el b/lisp/emacs-lisp/byte-run.el
index d159c15d28e..db123fb997c 100644
--- a/lisp/emacs-lisp/byte-run.el
+++ b/lisp/emacs-lisp/byte-run.el
@@ -498,23 +498,23 @@ is enabled."
"Like `progn', but prevents compiler WARNINGS in BODY.
WARNINGS is an associative list where the first element of each
-list is a warning type, and the rest of the elements in each list
+item is a warning type, and the rest of the elements in each item
are symbols they apply to. For instance, if you want to suppress
byte compilation warnings about the two obsolete functions `foo'
-and `bar', and the obsolete variable `zot' (being called with the
-wrong number of parameters), say
+and `bar', as well as the function `zot' being called with the
+wrong number of parameters, say
\(with-suppressed-warnings ((obsolete foo bar)
(callargs zot))
- (foo)
- (bar 1 2))
-
-The warnings that can be suppressed is a subset of the list in
-`byte-compile-warning-types'; see this for a fuller explanation
-of these warning types. The types that can be suppressed with
-this macro is `free-vars', `callargs', `redefine', `obsolete',
-`interactive-only', `lexical', `mapcar', `constants' and
-`suspicious'.
+ (foo (bar))
+ (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'.
For the `mapcar' case, only the `mapcar' function can be used in
the symbol list. For `suspicious', only `set-buffer' can be used."