[TransWarp] PEAK: what, why and how (was: Finding an object that provides the interface)

[Phillip J. Eby]

At 09:43 PM 5/21/03 +0400, Oleg Broytmann wrote:
>On Wed, May 21, 2003 at 12:34:15PM -0400, Phillip J. Eby wrote:
> > Given this confusion, I'm strongly considering renaming the 'provides'
> > keyword and 'registerProvider()' method in alpha 3, perhaps to something
> > like 'publishAs' and 'publishProvider()'.  Now that the protocols package
> > talks about "providing" interfaces, it seems easy to confuse this with a
> > component "providing" a utility or properties to its children.  So maybe
> > the terminology should change to a component "publishing" utilities and
> > properties, as that is a very different thing.
>
>    What peak really needs is good documentation. Thanks to developers, it
>is open source, so the "how" part is (almost) documented. All you need is
>to provide (pun intended!) docs on what is there and why, and how a user is
>expected to use it.

That's quite true.  However, there is quite a bit of interface 
documentation available on some of the items you ask about, mainly on the 
details of what methods are available, what to pass, etc.  If you read 
nothing else of a package's source, the 'interfaces' modules are generally 
a must-read.