Click here to get back home

Keeping POD in a separate file
 Home | NewsGroups | Search | About
Login Password
Register Now!
 comp.lang.perl.modules    Post an article   get this group's latest topics as an RSS feed add this group's latest topics to your My MSN content add this group's latest topics to your My Yahoo content
Subject Author Date
Keeping POD in a separate file Steve Roscio 01-10-2008
Posted by Steve Roscio on January 10, 2008, 4:18 pm
Please log in for more thread options
 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

Posted by ron on January 19, 2008, 6:52 pm
Please log in for more thread options
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.

Posted by Bernie Cosell on January 20, 2008, 8:35 am
Please log in for more thread options
ron@savage.net.au 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 <--

Similar ThreadsPosted
install HTML::Template - Problem reading cache file / Bad file number July 24, 2004, 7:55 pm
Reading contents of an excel file from a test file May 15, 2007, 2:49 am
A do-file location: how the code inside that do-file find it? January 20, 2008, 12:32 am
DBD:mysql doesn't read mysql option file /etc/my.cnf file January 27, 2005, 11:19 pm
Win32::File August 29, 2004, 9:08 pm
SGI::FAM and File::PathConvert June 14, 2005, 10:58 am
file upload January 5, 2006, 7:00 am
How to read an IFO file ? February 25, 2006, 3:12 pm
How to get the length of wav file? May 16, 2006, 1:01 am
Regarding thesaurus iso file July 21, 2006, 6:42 am

Our other projects:

Art Dolls, Fairies and Mermaids - Sunnyfaces.net

Roy's Linux, Programming and Search Engines messages

1-Script XML SitemapXML Sitemap