This is the mail archive of the guile@cygnus.com mailing list for the guile project.


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]

Re: Guile documentation (was Re: [RFD] Guile projects page)


thi <ttn@mingle.glug.org> writes:

> ok how about considering the inverse...  write good docs and then have
> source code update to use those docs (extract source code docstrings
> from the doc source file).  the process is simpler in this direction
> because formatting cruft from docs can be removed rather than added.
> this also encourages people to describe their interfaces before starting
> to hack, an unpopular practice at this time...

It's easy enough to just put the prototypes and the documentation in a
file before coding as a description of a new module.  I'm more
interested in the documentation of the existing system, though embedded
documentation certainly is a big win with new code, too.

Greg