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)


Greg Badros <gjb@cs.washington.edu> writes:

> Greg Harvey <Greg.Harvey@thezone.net> writes:
> 
> > > For example, who is working on the documentation for guile-core?  A
> > > handful of volunteers, well-organized, could get this done in a week or
> > > two, and it'd be a *huge* win for the project.  
> > 
> > I've been doing something like this with the qdocs
> > (http://home.thezone.net/~gharvey/guile/qdocs), but it's really 
> 
> This looks as though it might be a good starting place for the
> tutorial/example section (stressing that aspect in those docs might be
> the best plan).  I'm still convinced that using some documentation
> extraction (from the source) tool is an ideal way to get the reference
> documentation done pretty quickly and thoroughly.  Last I remember, Jim
> had a different plan, but I've not heard more about how that's
> progressing (or not progressing?).

The main problem with extraction is, well, there isn't currently much
to extract. I think it's a pretty good idea (but then again, I tend to
put a lot of explanatory comments in anyway). The first thing that'll
probably be necessary is to group guile's source files into logical
units (all the files dealing with files, data structures,
etc... though there's quite a bit of overlap in some places). I'll try
to take a look at this (though for the next little while I'm going to
be very slow at just about everything... quiting smoking is a real
distraction :'(... though a good excuse to play a bunch of quake2 >:').

> Greg B. (Maybe we should pick codenames :-) )
> 

Ooo, dibs on Shaft!

-- 
Shaft: he's a bad mutha (shut your mouth!). :')