Re: Docstrings and Reference manual (Re: Discussing Guile and revising interfaces)

["Greg J. Badros" <gjb at cs dot washington dot edu>]

Mikael Djurfeldt <mdj@mdj.nada.kth.se> writes:

> Keisuke Nishida <kxn30@po.cwru.edu> writes:
> 
> > Is there a plan how to implement the reference manual?
> 
> There are some plans.  We're right now looking for a candidate
> reference manual author.  I've contacted one person and am waiting for
> his answer.
> 
> > If most part of the manual is going to be written as docstrings,
> 
> The docstrings will be an important basis for the reference manual.
> However, the reference manual won't be automatically generated from
> the docstrings.
> 
> > I'd like to discuss the detailed format of the docstrings.  I'm
> > thinking of extending the docstring format so that we can add
> > "properties" to each docstring.
> 
> I think your suggestions are very interesting.  The interface for such
> properties could be `procedure-property' et al.  The properties need
> not be loaded to begin with, but can be loaded on demand from a
> database file.
> 
> But this is Greg's area of responsibility.  Let's see what he has to
> say.

As I think we agree, the properties should be added to the function, not
the docstring, but otherwise sounds reasonable.  What kinds of
properties are you thinking about?

Thanks,
Greg