Beefy Boxes and Bandwidth Generously Provided by pair Networks
Keep It Simple, Stupid
 
PerlMonks  

Re: New name for Tangram?

by simonm (Vicar)
on Jul 19, 2005 at 16:12 UTC ( #476164=note: print w/ replies, xml ) Need Help??


in reply to New name for Tangram?

This naming problem seems to be common in areas with several large and roughly-similar solutions. Those similarities complicate the "use a descriptive module name" guideline that we'd otherwise aim for. (For example, if people didn't use project names like "Maypole" and "Catalyst", how many modules would we have with almost indistinguishable names like "Web::SimpleMVC", "Web::NiftyMVC" and "Web::FastMVC"?)

I think that the simplest step is to start by moving Tangram under a descriptive top-level namespace like DBIx:: or Persistence:: so that people who see the name at least have some basic idea of what it does. To quote from perlmodlib and perlmodstyle:

  • Please use nested module names to group informally or categorize a module. There should be a very good reason for a module not to have a nested name.
  • Avoid starting a new top-level hierarchy, especially if a suitable hierarchy already exists under which you could place your module.

For what it's worth, the DBIx:: namespace does seem to be well known, and it's where I put my own DBIx::SQLEngine. Changing the name to DBIx::Tangram seems minimally disruptive, and people who were looking for it under the old name would quickly find the new one.

If you want to go further, here are a few more naming tips from perlmodlib and perlmodstyle:

  • Generally the name should reflect what is special about what the module does rather than how it does it.
  • Always try to use two or more whole words.
  • To be portable each component of a module name should be limited to 11 characters.
  • Be consistent with existing modules.

Based on those suggestions, I'd be thinking of something along the lines of "DBIx::OrthoganalPersistence" or "DBIx::PersistenceMapping" -- those examples are both too long, but at least when you see them you have some idea of what the module does.


Comment on Re: New name for Tangram?

Log In?
Username:
Password:

What's my password?
Create A New User
Node Status?
node history
Node Type: note [id://476164]
help
Chatterbox?
and the web crawler heard nothing...

How do I use this? | Other CB clients
Other Users?
Others having an uproarious good time at the Monastery: (4)
As of 2014-12-29 07:49 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    Is guessing a good strategy for surviving in the IT business?





    Results (185 votes), past polls