[ZWeb] Q: Available for participation?

Chris McDonough chrism@zope.com
Sat, 20 Apr 2002 09:53:46 -0400


This goes back to needing to define interfaces for lots of stuff in Zope=20
3.  Probably any method of any class that has security declarations=20
associated with it should be documented in the help system, as by=20
nauture it can be called by TTW code.  Dieter's docfinder is good at=20
indentifying methods with security declarations.

If someone wants to tackle it, it would be good to pick out a couple of=20
existing Zope Help system API docs and compare them with the output of=20
Dieter's tool for the same class.  Then add the undocumented methods to=20
help system interface files and upload them as attachments here.

I'd rather not have yet another system where API docs can be found,=20
that's why I'm suggesting we add the methods to the help system.

Bak @ kedai wrote:
> hi
> i'm currently looking at the viability of using dieter's docfinder to
> document *all* available methods in all classes.
>=20
> are there any prefferred ways in tackling this?  i sent samples to chri=
sm
> and he suggested that i do the docfinder thing and compare it with the =
zope
> help system.
>=20
> what to include, what to leave out?  should it be stored in any particu=
lar
> form?
>=20
> to easily integrate the APIs, can the nzo use pydoc and serve all avail=
able
> "help" file?  DaJoker has one available, and if nzo can have this, that=
'd be
> good too.  that's auto doc :)
>=20
> sorry for the incoherent thinking.  my train of thoughts is not on sche=
dule
> ;)
>=20
> -----Original Message-----
> From: Paul Everitt <paul@zope.com>
> To: dgieff@divinerites.com <dgieff@divinerites.com>
> Cc: zope-web@zope.org <zope-web@zope.org>
> Date: Saturday, April 20, 2002 3:37 AM
> Subject: Re: [ZWeb] Q: Available for participation?
>=20
>=20
>=20
>>The fact is, we need more people that don't do those things!  There's a
>>huge role in the plan for the new zope.org: section owners.
>>
>>We're trying to organize the site into sections.  For instance,
>>documentation is a section.  These sections will have section home page=
s
>>that try to organize the material, show the most recent items, feature
>>selected material, etc.
>>
>>All of this is an editorial process.  Thus, we need people that can hel=
p
>>adopt a section.  Those that jump in now and commit to leadership on
>>this can really affect the outcome.
>>
>>--Paul
>>
>>On Fri, 2002-04-19 at 11:59, Didier Georgieff wrote:
>>
>>>>>Hello everyone.  In the next week there will be a major push to move
>>>>
> the
>=20
>>>>>project forward.  I'll lead with the question:
>>>>>
>>>>>Who on this list can contribute hours (over 5) during the course of
>>>>
> the
>=20
>>>>>next week?
>>>>
>>>Paul,
>>>
>>>I didn't knew this list ;-< sorry ! (got the information thru the
>>>ZopeMag thread)
>>>
>>>So, i can't write python, i can't write good english, i'm useless at
>>>design, but count me in for whatever including using the broom in
>>>dark corners.
>>>
>>>In between, i'll read the zope-dev archive to find where i can help.
>>>
>>>Regards.
>>>
>>>
>>>--
>>>Didier Georgieff
>>>D=E9l=E9gation Interservice pour le D=E9veloppement du SIT67
>>>t=E9l : 03.88.76.78.35 - fax : 03.88.76.78.34
>>>email : didier.georgieff@agriculture.gouv.fr
>>
>>
>>
>>
>>_______________________________________________
>>Zope-web maillist  -  Zope-web@zope.org
>>http://lists.zope.org/mailman/listinfo/zope-web
>>
>=20
>=20
>=20
>=20
> _______________________________________________
> Zope-web maillist  -  Zope-web@zope.org
> http://lists.zope.org/mailman/listinfo/zope-web


--=20
Chris McDonough                    Zope Corporation
http://www.zope.org             http://www.zope.com
"Killing hundreds of birds with thousands of stones"