Home > Archive > PERL Modules > January 2008 > Keeping POD in a separate file
You are viewing an archived Text-only version of the thread.
To view this thread in it's original format and/or if you want to reply to
this thread please [click here]
| Author |
Keeping POD in a separate file
|
|
| Steve Roscio 2008-01-10, 7:02 pm |
| Another "Perl Culture" kind of question:
For CPAN packages, is it normal/acceptable/OK to have the POD for a
module in a separate .pod file, instead of inside the .pm?
MyModule.pm
MyModule.pod
MyModule/SubThing1.pm
MyModule/SubThing1.pod
...etc
Of course, pod_coverage.t will need tweaking.
Besides that, is this unusual or considered not good to do?
[For this case, I autogenerate much of the POD for the ~100 .pm's,
so it makes it easier for me to keep them separate.]
Thanx,
- Steve
| |
| ron@savage.net.au 2008-01-19, 7:01 pm |
| On Jan 11, 8:18 am, Steve Roscio <steve.ros...@hp.com> wrote:
Hi Steve
> For CPAN packages, is it normal/acceptable/OK to have the POD for a
> module in a separate .pod file, instead of inside the .pm?
Usually the POD is in the same file as the *.pm, but does not have to
be.
Some authors are concerned with the size of the POD affecting the
speed of Perl parsing the *.pm, and hence prefer to keep the POD
separately.
They're your modules, so suit yourself.
| |
| Bernie Cosell 2008-01-20, 7:01 pm |
| ron@savage.net.au wrote:
} On Jan 11, 8:18 am, Steve Roscio <steve.ros...@hp.com> wrote:
}
} Hi Steve
}
} > For CPAN packages, is it normal/acceptable/OK to have the POD for a
} > module in a separate .pod file, instead of inside the .pm?
}
} Usually the POD is in the same file as the *.pm, but does not have to
} be.
} Some authors are concerned with the size of the POD affecting the
} speed of Perl parsing the *.pm, and hence prefer to keep the POD
} separately.
Can't you ameliorate that by putting the POD info after an __END__?
/Bernie\
--
Bernie Cosell Fantasy Farm Fibers
bernie@fantasyfarm.com Pearisburg, VA
--> Too many people, too few sheep <--
|
|
|
|
|