Mercurial > emacs
comparison lispref/tips.texi @ 78503:a3be21a96dd1
(Documentation Tips): Recommend against `iff'.
author | Glenn Morris <rgm@gnu.org> |
---|---|
date | Wed, 08 Aug 2007 07:56:45 +0000 |
parents | 665e86db2a21 |
children | a1e16e813aed 424b655804ca |
comparison
equal
deleted
inserted
replaced
78502:5798b9d885ed | 78503:a3be21a96dd1 |
---|---|
843 Avoid using the word ``cause'' (or its equivalents) unnecessarily. | 843 Avoid using the word ``cause'' (or its equivalents) unnecessarily. |
844 Instead of, ``Cause Emacs to display text in boldface,'' write just | 844 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: |
851 | 857 |
852 @example | 858 @example |