chicken-users
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[Chicken-users] Note to eggdoc users on chicken-doc


From: Jim Ursetto
Subject: [Chicken-users] Note to eggdoc users on chicken-doc
Date: Fri, 22 Jan 2010 12:42:37 -0600

Hello, eggdoc users.  chicken-doc now supports eggdoc, but a few
issues arose with existing eggdocs, described below.

If you modify an eggdoc, ideally make a new SVN tag (if you use
tags/), because the repository scan for eggdocs uses the newest
released egg.

1) I fixed minor typos in: glpk lalr mpi mw.  Please review.
2) z3 maintainer, please retag your egg as 1.40, because 1.4 < 1.39.
3) pandora maintainer, if you want your egg to be parsable, please
generate and include `demo.html` in the repository.
4) raikov, some of your procedure signatures are non-standard ---
foo:: a * b * c -> d.  I modified chicken-doc-admin to understand
them, but ideally they would be made standard --- (foo a b c) -> d.
5) Definition grouping: When you have related procedure, macro, etc.
definitions that share the same descriptive text, you need to use a
particular form:

(definition
  (signatures
   (signature "procedure" "(foo bar)")
   (signature "procedure" "(baz bat)")
   (signature "macro" "(quux phlox)"))
  (p "This describes foo, baz and quux."))

I apologize that this form is clunky.  However, separating the
definitions like (procedure ...) (procedure ...) instead defines
independent, non-grouped procedures. Nesting (procedure ... (procedure
...)) will produce undefined behavior.

Any questions let me know.
Jim




reply via email to

[Prev in Thread] Current Thread [Next in Thread]