guile-devel
[Top][All Lists]
Advanced

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

Re: [PATCH] Turn on more documentation


From: Ludovic Courtès
Subject: Re: [PATCH] Turn on more documentation
Date: Sun, 06 May 2012 12:14:22 +0200
User-agent: Gnus/5.110018 (No Gnus v0.18) Emacs/24.0.93 (gnu/linux)

Hi,

Noah Lavine <address@hidden> 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 Library" section
> of the manual is snarfed from .scm source files.) This patch makes
> Guile build documentation for (ice-9 binary-ports), (ice-9
> common-list), (ice-9 documentation), (ice-9 gap-buffer), (ice-9 runq),
> (ice-9 serialize), and (ice-9 time). It gets incorporated into the
> manual as part of the "Standard Library" section.

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

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?

Thanks,
Ludo’.




reply via email to

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