[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [Chicken-users] egg documentation
From: |
Mario Domenech Goulart |
Subject: |
Re: [Chicken-users] egg documentation |
Date: |
12 Feb 2008 15:16:35 -0200 |
User-agent: |
Gnus/5.09 (Gnus v5.9.0) Emacs/21.4 |
Hi Mark,
On Tue, 12 Feb 2008 10:52:02 -0600 "Mark Fredrickson" <address@hidden> wrote:
> This idea dove tails with discussion last week of providing docstrings
> for lambdas. Felix pointed out that there is a hook to capture lambda
> documentation. Will this work for documenting eggs, which might also
> have data types, parameters, other info?
I'm not sure if that's a good way to provide full documentation for
eggs and chicken.
One of the problems I see is that there are other types of objects
besides lambdas.
The full documentation for eggs and chicken itself is more than the
documentation of procedures and other objects. There are examples,
authors, license sections etc, which are not source code.
I'm afraid merging two sources of documentation (from source code
files and, I guess, manually written doc files) can lead to confusion
and "kludgeness".
Best wishes,
Mario
- [Chicken-users] egg documentation, Graham Fawcett, 2008/02/12
- [Chicken-users] Comprehensive documentation rewrite, Tobia Conforto, 2008/02/12
- Re: [Chicken-users] Comprehensive documentation rewrite, Mario Domenech Goulart, 2008/02/12
- Re: [Chicken-users] Comprehensive documentation rewrite, Tobia Conforto, 2008/02/12
- Re: [Chicken-users] Comprehensive documentation rewrite, Mario Domenech Goulart, 2008/02/12
- Re: [Chicken-users] Comprehensive documentation rewrite, Mark Fredrickson, 2008/02/12
- Re: [Chicken-users] Comprehensive documentation rewrite, Graham Fawcett, 2008/02/12
- Re: [Chicken-users] Comprehensive documentation rewrite, Graham Fawcett, 2008/02/12
- Re: [Chicken-users] Comprehensive documentation rewrite, Mario Domenech Goulart, 2008/02/12