documentation categories, was: conventions for .texi files
Subject: documentation categories, was: conventions for .texi files
From: Robert Dodier
Date: Mon, 6 Dec 2004 21:13:55 -0800 (PST)
--- "Vadim V. Zhytnikov" <vvzhy@mail.ru> wrote:
[...]
> Nothing is wrong with this example. The point is that if we have
> somefoo which belongs to two categories CAT1 and CAT2 (say
> Function and Package) we can describe it using two different ways.
>
> First, asymmetric way. It is presumed that foo as CAT1 is more
> important and foo as CAT2 is something just worth mentioning.
> Thus we have only one @def entry:
[...]
>
> Second, perfectly symmetric way:
[...]
> The only problem is that probably this two descriptions
> must be in different sections. Otherwise describe
> may be confused (maybe not, I have to check).
Yes, describe is confused -- it doesn't see the second
foo description. But maybe it wouldn't be hard to fix it.
In reading this, I realized that we've been talking about
categories in two different senses. I think you mean to
use categories to disambiguate different items that have
the same name (e.g., a function and a variable with the
same name). I mean to use categories to organize the same
item under different headings, e.g., putting "save"
under functions, system functions, and i/o functions.
For what it's worth,
Robert Dodier
__________________________________
Do you Yahoo!?
Yahoo! Mail - Find what you need with new enhanced search.
http://info.mail.yahoo.com/mail_250