[Bioperl-l] Module names

Hilmar Lapp hilmarl@yahoo.com
Wed, 26 Sep 2001 16:39:27 -0700


Jason Eric Stajich wrote:
> 
> We don't really have a policy laid out in the wiki for module naming
> standards but I wondered if we should.
> 
> Dave should Bio::SeqFeature::Gene::utr be Bio::SeqFeature::Gene::UTR ?
> or Utr ?  And Bio::SeqFeature::Gene::poly_A_site be Poly_A_site ?  Just
> checking if we should try and enforce a standard before we approach
> releases.
> 
> My proposal would be all modules start with a capital letter unless (as in
> the case of SeqIO/AlignIO modules) there is a specific reason to make them
> lowercase.  Taking it one step further perhaps - all modules which one
> expects to instantiate directly (imagine there is a general Bioperl API)
> should start with a capital letter?

Sounds good to me. Actually I agree that lower-case module names
should indicate by this that a user normally doesn't want to
instantiate them (i.e. lower case to be reserved for things like
drivers etc).

	-hilmar
-- 
-------------------------------------------------------------
Hilmar Lapp                            email: lapp@gnf.org
GNF, San Diego, Ca. 92121              phone: +1-858-812-1757
-------------------------------------------------------------