diff options
| author | Glenn Morris | 2007-08-08 08:01:42 +0000 |
|---|---|---|
| committer | Glenn Morris | 2007-08-08 08:01:42 +0000 |
| commit | 6c4a608e90ea2751932464690fcb7affa41b047a (patch) | |
| tree | c030e84447353772b7ad371c09df97b386ffd936 /lispref | |
| parent | 6d5baad533e588d71506bb53fbf67bc4cae58f0b (diff) | |
| download | emacs-6c4a608e90ea2751932464690fcb7affa41b047a.tar.gz emacs-6c4a608e90ea2751932464690fcb7affa41b047a.zip | |
(Documentation Tips): Recommend against `iff'.
Diffstat (limited to 'lispref')
| -rw-r--r-- | lispref/tips.texi | 6 |
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 | |||
| 845 | ``Display text in boldface.'' | 845 | ``Display text in boldface.'' |
| 846 | 846 | ||
| 847 | @item | 847 | @item |
| 848 | Avoid using ``iff'' (a mathematics term meaning ``if and only if''), | ||
| 849 | since many people are unfamiliar with it and mistake it for a typo. In | ||
| 850 | most cases, the meaning is clear with just ``if''. Otherwise, try to | ||
| 851 | find an alternate phrasing that conveys the meaning. | ||
| 852 | |||
| 853 | @item | ||
| 848 | When a command is meaningful only in a certain mode or situation, | 854 | When a command is meaningful only in a certain mode or situation, |
| 849 | do mention that in the documentation string. For example, | 855 | do mention that in the documentation string. For example, |
| 850 | the documentation of @code{dired-find-file} is: | 856 | the documentation of @code{dired-find-file} is: |