summaryrefslogtreecommitdiff
path: root/lispref
diff options
context:
space:
mode:
authorGlenn Morris <rgm@gnu.org>2007-08-08 08:01:42 +0000
committerGlenn Morris <rgm@gnu.org>2007-08-08 08:01:42 +0000
commit6c4a608e90ea2751932464690fcb7affa41b047a (patch)
treec030e84447353772b7ad371c09df97b386ffd936 /lispref
parent6d5baad533e588d71506bb53fbf67bc4cae58f0b (diff)
downloademacs-6c4a608e90ea2751932464690fcb7affa41b047a.tar.gz
(Documentation Tips): Recommend against `iff'.
Diffstat (limited to 'lispref')
-rw-r--r--lispref/tips.texi6
1 files changed, 6 insertions, 0 deletions
diff --git a/lispref/tips.texi b/lispref/tips.texi
index de590c4cf9d..f3070f4659b 100644
--- a/lispref/tips.texi
+++ b/lispref/tips.texi
@@ -845,6 +845,12 @@ Instead of, ``Cause Emacs to display text in boldface,'' write just
``Display text in boldface.''
@item
+Avoid using ``iff'' (a mathematics term meaning ``if and only if''),
+since many people are unfamiliar with it and mistake it for a typo. In
+most cases, the meaning is clear with just ``if''. Otherwise, try to
+find an alternate phrasing that conveys the meaning.
+
+@item
When a command is meaningful only in a certain mode or situation,
do mention that in the documentation string. For example,
the documentation of @code{dired-find-file} is: