Howdy,
I was thinking of writing a proposal for killing the current
API reference (in lib/python/Products/OFSP/help)
and replacing it with the actual docstrings of the actual classes.
But before I write the proposal ... can somebody tell me
what was the rationale for the way it is?
--
Paul
I'm not sure there is a rationale, other than it was composed before
Interfaces existed and the thing to do at the time was to create docs
that went into the hurt^H^H^H^Hhelp system. I think the real answer
would be to go and create interfaces for all API classes and turn that
into an API
On Sunday 04 April 2004 13:56, Chris McDonough wrote:
I'm not sure there is a rationale, other than it was composed before
Interfaces existed and the thing to do at the time was to create docs
that went into the hurt^H^H^H^Hhelp system. I think the real answer
would be to go and create
On Sun, Apr 04, 2004 at 01:56:21PM -0400, Chris McDonough wrote:
I'm not sure there is a rationale, other than it was composed before
Interfaces existed and the thing to do at the time was to create docs
that went into the hurt^H^H^H^Hhelp system. I think the real answer
would be to go and
On Sun, Apr 04, 2004 at 02:24:55PM -0400, Stephan Richter wrote:
On Sunday 04 April 2004 13:56, Chris McDonough wrote:
I'm not sure there is a rationale, other than it was composed before
Interfaces existed and the thing to do at the time was to create docs
that went into the
On Sunday 04 April 2004 15:23, Paul Winkler wrote:
Yeah, I guess the best way would be to do interfaces. Then you can use
parts of the Zope 3 API documentation tool (actually all of the Interface
and Class doc module) and generate docs.
I note in lib/python/Interfaces/IInterface.py, there
I've posted my proposal:
http://dev.zope.org/Wikis/DevSite/Proposals/SanitizeHelpSysAndAPIReference
Motivation
The current Help system in Zope 2 is sometimes jokingly referred to as
the hurt^H^H^H^Hhelp system. The online API reference in the Zope Book,
which AFAICT is extracted from the help
On Sun, Apr 04, 2004 at 04:21:16PM -0400, Stephan Richter wrote:
class FooBar:
? ? implements(IFoo, IBar)
This is the only way used in Zope 3.
class FooBar:
? ? __implements__ = (IFoo, IBar)
This is mainly for backward-compatibility, I understand.
got it, thanks.
--
Paul
On Sun, 2004-04-04 at 17:50, Paul Winkler wrote:
I've posted my proposal:
http://dev.zope.org/Wikis/DevSite/Proposals/SanitizeHelpSysAndAPIReference
Motivation
The current Help system in Zope 2 is sometimes jokingly referred to as
the hurt^H^H^H^Hhelp system. The online API reference
On Sun, 2004-04-04 at 15:20, Paul Winkler wrote:
I'm not
sure that exposing the docstrings of the classes themselves would be
much better than the current situation,
well, it would arguably make it marginally more likely that the api
reference is updated when the code is updated.
On Sun, Apr 04, 2004 at 05:02:39PM -0400, Chris McDonough wrote:
FWIW, the old Zope Book sourceforge project (where?) had some code to
generate the API reference chapter from the helpsys. I didn't use it
because the API reference was stepchilded during the Zope Book
rewrite, but it could be
On Sun, Apr 04, 2004 at 05:06:52PM -0400, Chris McDonough wrote:
The objects must have a docstring to be publishable misfeature works
against us here too if you want to get docs from code.
But that would be a non-issue if I create interfaces, right?
... Making
interfaces does seem like the
On Sun, 2004-04-04 at 18:15, Paul Winkler wrote:
On Sun, Apr 04, 2004 at 05:06:52PM -0400, Chris McDonough wrote:
The objects must have a docstring to be publishable misfeature works
against us here too if you want to get docs from code.
But that would be a non-issue if I create
On Fri, 2004-04-02 at 17:37, Dieter Maurer wrote:
Syver Enstad wrote at 2004-4-2 11:38 +0200:
I am checking out how to use ZODB with twisted web. I thought that I
would have the DB instance globally accesible and call the open method
to get a connection on each request. I thought that if I use
14 matches
Mail list logo
