This is the mail archive of the
guile@sourceware.cygnus.com
mailing list for the Guile project.
Re: Docstring question
"John W. Eaton" <jwe@bevo.che.wisc.edu> writes:
> On 7-Dec-1999, Daschbach, John L <John.Daschbach@pnl.gov> wrote:
>
> | In my experience the best manuals are
> | structured around usage and provided with alphabetical indexes of
> | functions and variables. Two quite good manuals I think are Octave
> | and Emacs Lisp.
>
> Thanks! :-) The Octave manual owes a lot to the organization of the
> Emacs Lisp manual, as well as the Gawk and Emacs manuals. I think
> I've seen RMS write that a good manual must be more than just a
> laundry list of functions.
That's true, but a laundry list of functions (and variables) is much,
much better than nothing at all, and formally tying the function &
variable documentation to their declarations strongly helps the
laundry list to be complete and up to date.
--
Harvey Stein
Bloomberg LP
hjstein@bfr.co.il