Re: [PATCH] Turn on more documentation

2012-05-15 Thread Andy Wingo
Howdy, On Sun 06 May 2012 12:14, l...@gnu.org (Ludovic Courtès) writes: 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

Re: [PATCH] Turn on more documentation

2012-05-15 Thread Andy Wingo
On Mon 14 May 2012 17:14, Noah Lavine noah.b.lav...@gmail.com writes: I think of our current situation as having three top-level lists of functionality, in API Reference, Guile Modules, and Standard Library. How about just merging them into one list? It would be quite a big list. Would that

Re: [PATCH] Turn on more documentation

2012-05-15 Thread Ludovic Courtès
Hi, Andy Wingo wi...@pobox.com skribis: What if we merge Guile Modules and Standard Library into one Standard Library node, and keep API Reference as it is? Sounds good to me. Perhaps “Standard Library” could have sub-sections, like “Data Structures”, “Web”, “XML”, “Texinfo”, etc. Ludo’.

Re: [PATCH] Turn on more documentation

2012-05-14 Thread Ludovic Courtès
Hi Noah! Noah Lavine noah.b.lav...@gmail.com 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

Re: [PATCH] Turn on more documentation

2012-05-14 Thread Noah Lavine
Hello, 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

Re: [PATCH] Turn on more documentation

2012-05-14 Thread Ludovic Courtès
Hi! Noah Lavine noah.b.lav...@gmail.com skribis: Unless there is going to be some other distinction between core and extensions, it would seem more natural to me to document everything by functionality, in the same part of the manual. Some sections would correspond to modules, because

Re: [PATCH] Turn on more documentation

2012-05-14 Thread Noah Lavine
Hello, Unless there is going to be some other distinction between core and extensions, it would seem more natural to me to document everything by functionality, in the same part of the manual. Some sections would correspond to modules, because modules are also supposed to group things by

Re: [PATCH] Turn on more documentation

2012-05-12 Thread Noah Lavine
Hello, 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

Re: [PATCH] Turn on more documentation

2012-05-07 Thread Noah Lavine
Hello, 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

Re: [PATCH] Turn on more documentation

2012-05-07 Thread Ludovic Courtès
Hi! Noah Lavine noah.b.lav...@gmail.com skribis: Hello, 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

Re: [PATCH] Turn on more documentation

2012-05-06 Thread Ludovic Courtès
Hi, Noah Lavine noah.b.lav...@gmail.com skribis: As part of my investigation into modules that don't have documentation, I discovered that several modules in ice-9/ actually have usable documentation that we are just not using in our build process. (For reference, everything in the Standard