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: Scheme documentation question.


> > I realize that doing:
> > 
> >    (define-public variable doc-string value)
> > 
> > would break lots of code, but how about:
> > 
> >    (define-public variable value optional-doc-string)
> > 
> > Can't this be made to work?
> 
> This is a question more for the guile folks I think.  Variables don't
> have doc strings attached.  We could add a syntax:
> 
> (define-documented-variable VAR DOC-STRING VALUE)

Is anything wrong with:

(document-variable VAR DOC-STRING)

OK, I'll admit that you must type the variable name twice
and you might spell it wrong the second time, but why go for
something complicated when something simple will work?
Is it necessary for one function to do everything?

	- Tel