[Snow-users-list] Provide APIs in snowballs documentation

Ludovic Courtès ludo at gnu.org
Mon Jun 2 14:07:25 EDT 2008


Adrien Pierard <pierarda at iro.umontreal.ca>

> (define* (function args)
>   (annotation: "foo bar quux => dadidada")
>   (frobnicate args))
> This annotation only lives at compile time, and is deleted afterwards
> from interpreted code, but gives enough information when parsed to
> generate some text for the web page or to the snowman.

GNU Guile (which is an interpreter) has "docstrings" similar to what
Emacs Lisp has, i.e.,

  (define (make-chbouib foo bar)
    "Return a chbouib made from @var{foo} and @var{bar}."

It's simple, and Snow's `define*' could surely be made to discard such
docstrings when using a compiler---but even if it doesn't, having the
string in here doesn't hurt since it has no effect.


More information about the Snow-users-list mailing list