GNU bug report logs -
#56802
29.0.50; [PATCH] Cosmetic change to doc/lispref/tips.texi
Previous Next
Reported by: Arash Esbati <arash <at> gnu.org>
Date: Wed, 27 Jul 2022 18:00:02 UTC
Severity: normal
Tags: patch
Found in version 29.0.50
Done: Eli Zaretskii <eliz <at> gnu.org>
Bug is archived. No further changes may be made.
Full log
View this message in rfc822 format
[Message part 1 (text/plain, inline)]
Your bug report
#56802: 29.0.50; [PATCH] Cosmetic change to doc/lispref/tips.texi
which was filed against the emacs package, has been closed.
The explanation is attached below, along with your original report.
If you require more details, please reply to 56802 <at> debbugs.gnu.org.
--
56802: https://debbugs.gnu.org/cgi/bugreport.cgi?bug=56802
GNU Bug Tracking System
Contact help-debbugs <at> gnu.org with problems
[Message part 2 (message/rfc822, inline)]
> From: Arash Esbati <arash <at> gnu.org>
> Date: Wed, 27 Jul 2022 19:59:25 +0200
>
> Hi all,
>
> may I suggest this trivial change to tips.texi:
Thanks, I installed it on the emacs-28 branch. (Please in the future
always check whether a documentation change is applicable for a
release branch, and submit a patch relative to that if so.)
[Message part 3 (message/rfc822, inline)]
Hi all,
may I suggest this trivial change to tips.texi:
--8<---------------cut here---------------start------------->8---
diff --git a/doc/lispref/tips.texi b/doc/lispref/tips.texi
index d03698d354..9faf3f33ba 100644
--- a/doc/lispref/tips.texi
+++ b/doc/lispref/tips.texi
@@ -712,7 +712,7 @@ Documentation Tips
punctuation. For example:
@example
- CODE can be `lambda', nil, or t.
+CODE can be `lambda', nil, or t.
@end example
Note that when Emacs displays these doc strings, Emacs will usually
@@ -868,7 +868,7 @@ Documentation Tips
@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
+``cf.'' (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.}
--8<---------------cut here---------------end--------------->8---
It deletes a leading space in an example and fixes the abbreviation
cf. which is to my knowledge short for the Latin confer/conferatur,
i.e., only one word.
Best, Arash
This bug report was last modified 2 years and 355 days ago.
Previous Next
GNU bug tracking system
Copyright (C) 1999 Darren O. Benham,
1997,2003 nCipher Corporation Ltd,
1994-97 Ian Jackson.