This is the mail archive of the
guile@sourceware.cygnus.com
mailing list for the Guile project.
Re: Documentation lacking
- To: Derry Bryson <dbguile at ta1 dot reno-onramp dot com>
- Subject: Re: Documentation lacking
- From: "Greg J. Badros" <gjb at cs dot washington dot edu>
- Date: 22 Jan 2000 13:04:14 -0800
- Cc: "guile at sourceware dot cygnus dot com" <guile at sourceware dot cygnus dot com>
- References: <38895A88.3CF98D87@ta1.reno-onramp.com>
Derry Bryson <dbguile@ta1.reno-onramp.com> writes:
<snip>
> While this would seem to have been a good idea at the start, from
> my invesitagtion so far it seems to have been a complete waste of
> time. I can find no real documentation; I have looked at the
> documentation on the website, the documentation included with the
> latest release, and the documentation from CVS (guile-doc).
> What is the basis of the guile interpretation of scheme? How does it
> evaluate scheme expressions? I have found documentation on how it
> stores values, but not much else. What is the precision of integer
> values? Are
<snip>
Documentation is an admitted weak spot. I'm leading an effort to get
docstrings into the source code and then auto-generate the next version
of the reference section of the manual from those docstrings, as well as
exposing the docstrings in the run-time environment. I'm also
organizing the effort to flesh out the rest of the documentation, but my
first priority is the docstrings (and of course my time is very
limited).
I repeat my encouragement to any and everyone to contribute to the
docstring effort. Lots of files still need docstrings-- you can claim a
file using the online form at:
http://upintheair.cs.washington.edu/guile-doc-status/guile-doc-status.pl
And then submit your patches to me (and file papers with the FSF if your
contribution is more than 10 lines:
http://gcc.gnu.org/fsf-forms/assignment-instructions.html
[is there a better link for this??]).
<snip>
Greg