mirrors/emacs
1
Fork 0
mirror of git://git.sv.gnu.org/emacs.git synced 2025-12-23 22:20:24 -08:00
Code Issues Projects Releases Wiki Activity

Recommend to avoid unnecessary abbreviations in doc

Browse source 
* doc/lispref/tips.texi (Documentation Tips): Recommend to avoid
unnecessary abbreviations.  (Bug#40011)
This commit is contained in:
Stefan Kangas 2020-04-30 18:02:28 +02:00
parent aea1b4db72
commit 1d477a0fec
1 changed files with 8 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

8
doc/lispref/tips.texi
View file

@ -820,6 +820,14 @@ 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
Try to avoid using abbreviations such as ``e.g.'' (for ``for
example''), ``i.e.'' (for ``that is''), ``no.'' (for ``number''),
``c.f.'' (for ``in contrast to'') and ``w.r.t.'' (for ``with respect
to'') as much as possible. It is almost always clearer and easier to
read the expanded version.@footnote{We do use these occasionally, but
try not to overdo it.}
@item
When a command is meaningful only in a certain mode or situation,
do mention that in the documentation string. For example,