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: generating a manual from annotations in source code


>     Mark> We are not describing how the implementation works.  We are
>     Mark> describing the various APIs and how the programmer should
>     Mark> use them.
> 
>  But isn't that almost the same thing?  An understanding of how it
>  works internally can assist in designing good programs around it.

Not to be trite, but I want to document the interface, not its
implementation.  I guess it's all interface, but I want to distinguish
between what I'm promising you and what I'm not.