Jim Fulton wrote at 2006-10-5 08:50 -0400:
>Russ Ferriday wrote:
>> I'll provide some time for this, Jim.
>> I'm no expert on the ZODB, which might be spun as an advantage, and I'm
>> prepared to play a supporting role cleaning up doctests, or helping with
>> doc organization. This means I don't
Russ Ferriday wrote at 2006-10-5 13:45 +0100:
>I'll provide some time for this, Jim.
>I'm no expert on the ZODB, which might be spun as an advantage, and
>I'm prepared to play a supporting role cleaning up doctests, or
>helping with doc organization. This means I don't mind gathering
>spippet
Jim Fulton wrote at 2006-10-5 08:32 -0400:
> ...
>I think this is an area where a lot of volunteers could make
>contributions. Perhaps we could even schedule some ZODB "Doc days",
>similar bug days, but with a different emphasis.
>
>I won't insist that new work should wait for this effort
Good!
Jim Fulton wrote:
Dmitry Vasiliev wrote:
Jim Fulton wrote:
Thoughts? Is anyone willing to help out? Anybody interested in a
ZODB Doc Day?
I'll ready to help with the docs. I guess we'll can made some minor
API/code cleanup at the same time. But I think "ZODB Doc Days" is
unnecessary.
The
On 10/5/06, Dmitry Vasiliev <[EMAIL PROTECTED]> wrote:
What do you think about to use an API documentation tool, epydoc
(http://epydoc.sourceforge.net/) for example? Unfortunately I haven't used it
myself yet, but the examples looks promising (for example:
http://epydoc.sourceforge.net/api/epydoc
Dmitry Vasiliev wrote:
Jim Fulton wrote:
When I originally developed the ZODB, I created a UML model:
http://www.zope.org/Documentation/Developer/Models/ZODB
This provided a fairly thorough and clear documentation of
the ZODB architecture at the time. It still contains useful information.
U
Jim Fulton wrote:
When I originally developed the ZODB, I created a UML model:
http://www.zope.org/Documentation/Developer/Models/ZODB
This provided a fairly thorough and clear documentation of
the ZODB architecture at the time. It still contains useful information.
Unfortunately, the UML mo
Do you have some favorite documents that you would point me to as most accurate or up to date? Decent clues will be enough to get started. - Doc in test or source files - web pages, - forums chats, - email threadsWhat should one not bother with (out of date, incorrect, etc.)Anyone else feel f
On Oct 5, 2006, at 9:37 AM, Jim Fulton wrote:
Russ Ferriday wrote:
Do you have some favorite documents that you would point me to as
most accurate or up to date?
No, because I haven't used ZODB documentation much myself. :)
Decent clues will be enough to get started.
- Doc in test or so
On 5 Oct 2006, at 14:37, Jim Fulton wrote:Note that I suggest we want new documentation that is executable. Perhaps we can reuse some of this other material, but I'm mainly pointing out that this other content might give some hints about scope or organization. got it.--r Russ Ferriday - Topia S
Russ Ferriday wrote:
Do you have some favorite documents that you would point me to as most
accurate or up to date?
No, because I haven't used ZODB documentation much myself. :)
Decent clues will be enough to get started.
- Doc in test or source files
- web pages,
- forums chats,
-
Russ Ferriday wrote:
I'll provide some time for this, Jim.
I'm no expert on the ZODB, which might be spun as an advantage, and I'm
prepared to play a supporting role cleaning up doctests, or helping with
doc organization. This means I don't mind gathering spippets from those
who have them and
I'll provide some time for this, Jim.I'm no expert on the ZODB, which might be spun as an advantage, and I'm prepared to play a supporting role cleaning up doctests, or helping with doc organization. This means I don't mind gathering spippets from those who have them and pulling them together.--rOn
I'm happy that there is interest in improving ZODB. I think, however,
that the most pressing need is for documentation.
When I originally developed the ZODB, I created a UML model:
http://www.zope.org/Documentation/Developer/Models/ZODB
This provided a fairly thorough and clear documentatio
14 matches
Mail list logo
