[Bioperl-l] new/unannounced methods

Sendu Bala bix at sendu.me.uk
Thu Mar 8 12:04:16 EST 2007


Nathan Haigh wrote:
> I've come across a couple of methods that are commented as being
> new/unannounced e.g.:
> Bio::Location::Atomic::trunc
> 
> As it's not been documented with POD it reduces the POD coverage metric.
> I wondered if it makes sense to have these types of methods initially
> made private with the use of a leading underscore until it's unveiling?
> This way, programmers know not to touch the method from outside the
> module and the POD coverage doesn't see it as being missed.
> 
> Any thoughts?

I got the impression people are already trying to use them anyway, so 
changing the method name may not be ideal. I'd suggest adding POD that 
made it clear it was a method of dubious status.

Thank you for your efforts!



More information about the Bioperl-l mailing list