Shane Hathaway writes:

> Jason Spisak wrote:
> > I was just browsing the help system and can I just say it is terrfic.  The
> > .py files especially.  Not that python isn't that easy to read, but having
> > the ZQR type stuff handy online is a huge win.  Is that stuff updated from
> > the source on the fly?
> Almost.  It's actually written in separate files that mirror the
> structure of the real source.  And I'd like to bring up the point that
> I wonder why it is written that way.  Wouldn't it make more sense to
> self-document the source?
> If the issue is that some methods shouldn't be callable from a URL,
> there are better solutions to that problem (this is written to DC
> mainly):

Is this the reason that it's not pulling the docs from the source?
That's not a good idea.  With all the effort that Michel put in to work
around not documenting in the source, he could have fixed it so that it
pulled the docs from the source on the fly without effecting the URL

> 1) Enahnce the permissions system to include "Accessible via HTTP",
> "Accessible via FTP", etc.
> 2) Use an underscore as the first character of a docstring to indicate
> a non-URL-callable method.

I just looked at it and that seems like doing work twice.  Why not just
document your source?


Jason Spisak
6151 West Century Boulevard
Suite 900
Los Angeles, CA 90045
P. 310.665.3444
F. 310.665.3544

Under US Code Title 47, Sec.227(b)(1)(C), Sec.227(a)(2)(B) This email
address may not be added to any commercial mail list with out my
permission.  Violation of my privacy with advertising or SPAM will
result in a suit for a MINIMUM of $500 damages/incident, $1500 for

Zope-Dev maillist  -  [EMAIL PROTECTED]
**  No cross posts or HTML encoding!  **
(Related lists - )

Reply via email to