GNU bug report logs - #21472
25.0.50; REGRESSION: (emacs) `Coding Systems' uses curly quotes for Lisp strings

Previous Next

Full log

View this message in rfc822 format

From: Eli Zaretskii <eliz <at> gnu.org>
To: Paul Eggert <eggert <at> cs.ucla.edu>
Cc: 21472 <at> debbugs.gnu.org
Subject: bug#21472: 25.0.50; REGRESSION: (emacs) `Coding Systems' uses curly quotes for Lisp strings
Date: Wed, 16 Sep 2015 13:02:00 +0300

> Cc: 21472 <at> debbugs.gnu.org
> From: Paul Eggert <eggert <at> cs.ucla.edu>
> Date: Wed, 16 Sep 2015 00:48:51 -0700
> 
> Eli Zaretskii wrote:
> 
> > We index all terminology introduced in a manual, as a matter of
> > principle.
> 
> That's news to me, and the manuals often don't index terminology within @dfn. 
> For example, doc/emacs/basic.texi says @dfn{minor modes} but does not index the 
> term.  A quick eyeball of that file suggests that only about half of its terms 
> enclosed in @dfn are indexed.  I'm not opposed to having more index entries for 
> @dfns if someone wants to do it, but it doesn't appear to be a hard rule.

Many rules of good documentation are followed only partially.  That
doesn't make them any lesser.

This rule should be obvious: if you introduce and explain some
terminology, you should always consider the possibility that someone
will want to read about that terminology, and so it should be in the
index.

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.