Re: [PATCH] Turn on more documentation

[Ludovic Courtès]

Hi Noah!

Noah Lavine <address@hidden> skribis:

> 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.

>From “Organisation of this Manual”:

  *Chapter 6: Guile API Reference*
       This part of the manual documents the Guile API in
       functionality-based groups with the Scheme and C interfaces
       presented side by side.

  *Chapter 7: Guile Modules*
       Describes some important modules, distributed as part of the Guile
       distribution, that extend the functionality provided by the Guile
       Scheme core.

So I think the idea is for core functionality to be in Chapter 6, and
“peripheral things” to be in Chapter 7.  The modules you mention would
fall in the second category, I think.

>>>> 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.

One week is not a lot.  ;-)

Thanks,
Ludo’.