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



> > Summarized: this way, documentation is easily and flexibly generated by
> > developers, extracted by parsers and customized by guile users.
> 
> Actually, having the doc strings right inside of Lisp forms at defined
> locations is also quite easy to parse.

Until later on you decide to extend the system even further and support
international documentation which uses a single token in the place
of each docstring but then realise that there are already legitimate
cases where a similar token might be used in a function definition.

You might decide to have a function that returns docstrings but your
parser is set to look for strings and doesn't know whether this function
is designed to return a string or whether there is no documentation
and this function is part of the real definition.

	- Tel