[Bioperl-l] runnable SYNOPSIS

[Ewan Birney]

On Sat, 17 May 2003, Hilmar Lapp wrote:

> 
> On Saturday, May 17, 2003, at 12:07  PM, Heikki Lehvaslaiho wrote:
> 
> > The new rules for SYNOPSIS:
> >
> > 1. It should be possible to copy the whole SYNOPSIS and the perl
> >    compiler should not complain about its syntax.
> >
> > 2. The only exception to the above rule is one line paragraph
> >    linking to a Bio:: module with a relevant synopsis. E.g.:
> >
> 
> I think these are great rules, but I know for sure I'm going to fall 
> short of them every so  often, as in the first pass I document the 
> methods and then seldom manage to free up time for the second pass.
> 
> I think this is another great chance for those people out there who are 
> learning the toolkit and would like to make a contribution that helps 
> lots of other people save time and frustration caused by those 
> developers who don't finish their job wrt documentation (like myself :| 
> ).
> 
> 	-hilmar


I think this is a great thing to have, and I also like some sort of cron
jobs running these sorts of things and emailing bioperl-guts - first off
we need a cron job on test failures though of course.


But this is great. Raises the level of the whole project...


> 
> -- 
> -------------------------------------------------------------
> Hilmar Lapp                            email: lapp at gnf.org
> GNF, San Diego, Ca. 92121              phone: +1-858-812-1757
> -------------------------------------------------------------
> 
> _______________________________________________
> Bioperl-l mailing list
> Bioperl-l at bioperl.org
> http://pw600a.bioperl.org/mailman/listinfo/bioperl-l
> 

-----------------------------------------------------------------
Ewan Birney. Mobile: +44 (0)7970 151230, Work: +44 1223 494420
<birney at ebi.ac.uk>. 
-----------------------------------------------------------------