[Top][All Lists]

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: [PATCH] Turn on more documentation

From: Noah Lavine
Subject: Re: [PATCH] Turn on more documentation
Date: Sat, 12 May 2012 16:56:57 -0400


>>> The problem is that the auto-generated “Standard Library” section looks
>>> very poor in comparison to the rest of the manual.  So we should really
>>> try hard to write good doc by hands for these, and come up with a handy
>>> structure (instead of one node per module, all under “Standard
>>> Library”).
>> I could do that pretty easily, but I'm afraid that documentation that
>> isn't in the same file as the code would tend to be updated less often
>> than documentation in the same file.
> All of our manual except “Standard Library” is maintained this way.  It
> takes discipline to keep up-to-date, but it also leads to a better
> manual IMO.

Okay, I can write documentation this way too. I have a question about
this: what is the distinction between the sections "API Reference" and
"Guile Modules"? I need to figure out where documentation for
different modules goes.

>>> However, I believe Thien-Thi’s Guile 1.4 has good doc for at least some
>>> of these modules, and it would be great if it could be incorporated.
>>> WDYT?
>> That would be ideal, but I was concerned that the documentation wasn't
>> copyrighted by the FSF. Unless Thien-Thi is interested in contributing
>> it, of course.
> Yes, I was hoping he would be reading us, let’s see.  ;-)

After almost a week, I think I'll plan on writing it myself. If
someone else happens to contribute documentation, that'll be great


reply via email to

[Prev in Thread] Current Thread [Next in Thread]