emacs-27 1d477a0: Recommend to avoid unnecessary abbreviations in doc

[Stefan Kangas]

branch: emacs-27
commit 1d477a0fec2b31101960a75702d8ae1c99ed21e1
Author: Stefan Kangas <address@hidden>
Commit: Stefan Kangas <address@hidden>

    Recommend to avoid unnecessary abbreviations in doc
    
    * doc/lispref/tips.texi (Documentation Tips): Recommend to avoid
    unnecessary abbreviations.  (Bug#40011)
---
 doc/lispref/tips.texi | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/doc/lispref/tips.texi b/doc/lispref/tips.texi
index 3b8da35..5b09b2c 100644
--- a/doc/lispref/tips.texi
+++ b/doc/lispref/tips.texi
@@ -821,6 +821,14 @@ 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,
 the documentation of @code{dired-find-file} is: