[Bioperl-l] Having working code in documentation

Kris Boulez krbou@pgsgent.be
Wed, 11 Apr 2001 21:45:30 +0200


As suggeted in 
http://bio.perl.org/wiki/html/BioPerl/BioperlProgrammingConventions.html
I'm making the SYNOPSIS part of every module to be runnable code. As the
t directory of the distribution contains files in all different formats,
I find myself writing code like the following

    $inputfilename = "/path/to/bioperl-0.7.0/t/testaln.fasta";

What are the possibilities to get this to work when people view
(man/perldoc) the manual pages:

- do the translation at the 'make' stage (I'm not a make/MakeMaker
  specialist, so I gave no idea)
- have the people create the symlink from /path/to :)


P.S. As an aside: do we want this synopsis code to be '-w' and 'use
strict' clean ?


Kris,