[Zope-dev] Doc strings of IContentProvider

Fred Drake fdrake at gmail.com
Sun Nov 11 13:50:09 EST 2007


On Nov 11, 2007 1:34 PM, Thomas Lotze <thomas at thomas-lotze.de> wrote:
> To my understanding, the interface should only specify how an object
> behaves, not how it is obtained.

That's my understanding as well.

The interface should express how a provider of the interface behaves;
larger pictures should be documented in README.txt or other
documentation files.  In some cases, a "this is how it work" might be
appropriate, and in others it may be more reasonable to describe
"here's how it was designed to work."  But both of those go beyond the
interfaces themselves.

> Moreover, I suspect that it might be
> enough to require the presence of a parent for the sake of the security
> context (as stated in the doc string) without specifying that it must be a
> view. The way it is now, a view whose parent is something other than a
> view can never be its own content provider. As an example, this includes
> pagelets. Unless this is a conscious design choice, IMHO the interface's
> documentation should be worded more liberally.

I'm not knowledgeable enough about the pagelet and viewlet models to
have a meaningful opinion on this.


  -Fred

-- 
Fred L. Drake, Jr.    <fdrake at gmail.com>
"Chaos is the score upon which reality is written." --Henry Miller


More information about the Zope-Dev mailing list