This is the mail archive of the
guile@sourceware.cygnus.com
mailing list for the Guile project.
RE: Doc: ideas and status
- To: "'Greg J. Badros'" <gjb at cs dot washington dot edu>
- Subject: RE: Doc: ideas and status
- From: "Reynolds, Gregg" <greynolds at datalogics dot com>
- Date: Mon, 20 Dec 1999 13:25:07 -0600
- Cc: guile at sourceware dot cygnus dot com
> -----Original Message-----
> From: Greg J. Badros [mailto:gjb@cs.washington.edu]
> Sent: Monday, December 20, 1999 11:59 AM
> >
> > Something I forgot to add: we needn't put docstrings in the
> funcdefs for
> > RnRS stuff; instead we can markup the RnRS source with
> unique IDs, and
> > cross reference.
>
> I think it's better to have the guile docstrings be self-contained.
> We're not going to want to require linking to an RnRS document for you
> to get run-time documentation on, e.g., `map'.
>
Sorry, I think maybe I didn't make my meaning clear. I'm thinking that
those docstrings would be extracted and compiled at compile-time, just as
they are now. At edit-time, a simple macro would suffice to locate and
display the relevant section of RnRS. The only difference would be the the
marked-up RnRS doc would be considered source code; just like any header
with macros defined, only, different.
-gregg