Re[1]: Doc Tasks (was RE: docstrings in Guile!)

["Eric M. Ludlam" <zappo at ultranet dot com>]

>>> "Dale P. Smith" <dpsm@bigbird.en.com> seems to think that:
>> 
>> > A few questions.  What do you think about using Docbook instead of texinfo
>> > markup?  The official documentation is now out (available on the web!
>> > http://www.oasis-open.org/docbook/documentation/reference/html/docbook.html;
>> > but you should buy a copy so Norm gets money!)
>> 
>> That's a non-free documentation owned by a publishing company. It is exactly
>> the sort of thing that the GNU project does not need. I hate to be rude but
>> the texinfo format has some nice things about it, one of which is that you
>> can learn it in an hour using only free-software tools and free-software
>> documentation. OK, it doesn't support a lot of fancy features but what it does
>> it does well, and it does enough for my documentation needs.
>
>When scwm went with a sgml style markup, I wanted to say something, but since
>I am basically incoherent I didn't.  I don't want to make the same mistake.
>
>Please use texinfo.  Besides the above arguments, it just looks nicer.  There
>is good support for it in emacs.  I believe it has grown over time, features
>being added as they were needed.

I would like to agree with this sentiment.  As a long time emacs
hacker, a nice upgrade to a guile-mode would show documentation (in
texinfo) from a function definition in source code.  When hacking
emacs lisp source, it's built in, but the texinfo indexing support in
emacs would be a huge boon when trying to write a doc browser for
guile in emacs.

While I'm here, is there going to be style guide for documentation
strings in guile?  I wrote a documentation string style checking tool
for Emacs that could probably be hacked to also check scheme as long
as the style guidelines are the same.  See the TIPS section in the
Emacs Lisp reference manual for details on how Emacs likes its
strings.

Eric

-- 
|\/\/\___/\/\/|  Eric Ludlam                 zappo@gnu.org; zappo@ultranet.com
\____ o o ____/  Homepage:                      http://www.ultranet.com/~zappo
     )   (       Trebuchets:    http://www.ultranet.com/~zappo/trebuchet.shtml
    ( * * )      GNU:				            http://www.gnu.org
     \___/       Trevor Shea Ludlam:            Oct 16th, 1999, 5lbs 11oz 18in