From 6c4a608e90ea2751932464690fcb7affa41b047a Mon Sep 17 00:00:00 2001 From: Glenn Morris Date: Wed, 8 Aug 2007 08:01:42 +0000 Subject: [PATCH] (Documentation Tips): Recommend against `iff'. --- lisp/ChangeLog | 3 +++ lispref/tips.texi | 6 ++++++ 2 files changed, 9 insertions(+) diff --git a/lisp/ChangeLog b/lisp/ChangeLog index 65df7d26b15..29e9027e54e 100644 --- a/lisp/ChangeLog +++ b/lisp/ChangeLog @@ -4,6 +4,9 @@ * Replace `iff' in doc-strings and comments. + * help-mode.el (help-make-xrefs): Search for symbol constituents, + rather than just `-'. + 2007-08-08 Martin Rudalics * dired.el (dired-pop-to-buffer): diff --git a/lispref/tips.texi b/lispref/tips.texi index de590c4cf9d..f3070f4659b 100644 --- a/lispref/tips.texi +++ b/lispref/tips.texi @@ -844,6 +844,12 @@ Avoid using the word ``cause'' (or its equivalents) unnecessarily. 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, -- 2.39.2