[Zope3-checkins] RE: SVN: Zope3/trunk/doc/CHANGES.txt Added a note about capi tochanges.txt.

[Garrett Smith]

Philipp von Weitershausen wrote:
> tochanges.txt.
> 
> 
> Garrett Smith wrote:
>> Log message for revision 29397:
>>   Added a note about capi to changes.txt.
>> 
>> Changed:
>>   U   Zope3/trunk/doc/CHANGES.txt
>> 
>> +      - Added capi in zope.component, a short form of
>> zope.component, that can +        be in instead of zapi when zapi
>> cannot be used. This would be the case +        for packages that
>> don't want to create a dependency on zope.app or +        cannot
>> access zope.app.zapi directly (e.g. zope.app.traversing). If +      
>> your use case doesn't apply to this, continue using zope.app.zapi. 
> 
> As far as I see this, 'capi' is nothing that has been introduced as a
> genuine new thing. Code in which 'capi' appears simply does::
> 
>    import zope.component as capi
> 
> So, 'capi' is in fact nothing else than zope.component and I would
> actually prefer it spelling out 'zope.component' instead of aliasing
> it to 'capi' (especially in doctests since those are going to be read
> by newbies). 'capi' dilludes the fact that we're dealing with
> zope.component and maybe it even confused you in that it was a new
> thing...? 
> 
> To sum up, I would prefer if this entry in CHANGES.txt was removed
> (because it's just plain confusing) as well as references to 'capi' be
> replaced with what it really stands for, 'zope.component'.

I think this is a good suggestion. 'zope.component' is pretty easy to
write and it's not going to be used that much.

 -- Garrett