(Documentation Tips): Recommend against `iff'.
This commit is contained in:
parent
6d5baad533
commit
6c4a608e90
2 changed files with 9 additions and 0 deletions
|
|
@ -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 <rudalics@gmx.at>
|
||||
|
||||
* dired.el (dired-pop-to-buffer):
|
||||
|
|
|
|||
|
|
@ -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,
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue