[Zope3-dev] service names

[Gary Poster]

OK, I buy it.  "ErrorReporting" has all the things I prefer over 
"ErrorCollection" anyway, so I'm

+1 for "ErrorReporting"

since it seems to fit your very reasonable consistency suggestions and 
it conveys more of its purpose to me than the alternative.

Your naming convention suggestions also seem like a reasonable thing to 
put in the wiki.

Which reminds me (here I go muddying the email waters, mixing 
issues...): I think it might be a good idea to but stylistic convention 
guides in the source tree in README files, similar to the README in 
src/zope that describes the difference between zope and zope/app. 
Putting in a description of this convention into 
zope/app/services/README.txt, for instance, seems like a good idea. 
People looking at the source and considering contributing might forget 
to look at the wiki.  The wiki style suggestions are pretty big now too, 
so putting them in an actual set of documents (even CODING_STYLE.txt?) 
might be good.  Thoughts?

Gary

Steve Alexander wrote:
> 
>>> I don't mind ErrorCollection much, but prefer ErrorReports fwiw.
>>
>>
>> ErrorReports sounds good to me.
> 
> 
> I'm -1 on ErrorReports.
> 
> (But that doesn't mean I can't be persuaded ;-) )
> 
> 
> The reason is that which I outlined in the second part of my earlier email:
> 
> http://mail.zope.org/pipermail/zope3-dev/2003-February/005430.html
> 
> I proposed two kinds of service names. One kind is 'plural nouns'. This 
> kind is for services that manage a collection of components or a 
> collection of other things that are instrumental in a system's 
> architecture.
> 
> So, we have:
> 
>    HubIds, Roles, Permissions, Adapters, Interfaces, Utilities,
>    Skins, Views, Resources, Factories
> 
> I don't think 'ErrorReports' fits in here, because we aren't using the 
> service to manage error reports. An 'error report' itself isn't 
> particularly instrumental in a system. Compare this to a hubId, or a 
> Role, or an Adapter or a View.
> 
> The other kind of name I suggested is for services that provide the 
> means to do something. This seems much more like what the error service 
> is for: it collects important information about errors that have 
> occured. So, I think it should be called something like 'error 
> reporting' or 'error collection', and not 'error reports'.
> 
> 
> Then, there's the lesser issue of consistency among the names of 
> services that provide the means to do something. I suggested three schemes:
> 
> Nouns derived from verbs, for providing the means to do something
> 
>    Authentication, Subscription, Publication, ErrorCollection
> 
> or perhaps the participal form of the verb
> 
>    Authenticating, Subscribing, Publishing, ErrorReporting
> 
> or perhaps the infinitive of the verb
> 
>    Authenticate, Subscribe, Publish, ReportErrors
> 
> 
> Or, we could decide that this particular consistency is not so important.
> 
> -- 
> Steve Alexander
> 
> 
> 
>