[Top][All Lists]

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

[PATCH] Turn on more documentation

From: Noah Lavine
Subject: [PATCH] Turn on more documentation
Date: Wed, 2 May 2012 23:20:53 -0400

Hello all,

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.

This seems like an easy way to get documentation for a few more
modules. What do you think?

(You may have to do "rm doc/ref/standard-library.texi && rm
doc/ref/*" in order to build with the change. The makefile
doesn't know about all of the dependencies that it should.)

I also discovered while working on this that several modules have
in-line commentary and also hand-written texinfo pages. The list is
expect.scm, ftw.scm, futures.scm, getopt-long.scm, i18n.scm,
optargs.scm, q.scm, regex.scm, threads.scm, and vlist.scm. Was there a
reason for this? Perhaps the inline documentation format isn't as
flexible as writing it by hand?


Attachment: 0001-Turn-on-documentation-for-more-modules.patch
Description: Binary data

reply via email to

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