Beefy Boxes and Bandwidth Generously Provided by pair Networks
The stupid question is the question not asked
 
PerlMonks  

Re: Generated POD and CPAN/MetaCPAN

by LanX (Saint)
on Sep 05, 2014 at 22:05 UTC ( [id://1099734]=note: print w/replies, xml ) Need Help??


in reply to Generated POD and CPAN/MetaCPAN

I'm generating pod in one of my projects.

The documentation for Module.pm is written into Module.pod and calling perldoc Module shows the generated content in Module.pod (see perldoc )³.

To keep it synchronized I've integrated the call to my podbuilder.pl script into my test suite as “pseudo test“.

Since I never release² without testing¹, my documentation is always up to date and if podbuilder.pl fails then my test suite fails too.

(actually I still have to teach git-commit to stop telling that Module.pod has changed, don't wanna be told anymore about the obvious ;)

Works for me! :)

HTH!

Cheers Rolf

(addicted to the Perl Programming Language and ☆☆☆☆ :)

¹) Using the modulino principle to run the test suite facilitate things a lot.

²) even hardly ever commit w/o testing...

³) perldoc Module.pm for my internal developer documentation

Log In?
Username:
Password:

What's my password?
Create A New User
Domain Nodelet?
Node Status?
node history
Node Type: note [id://1099734]
help
Chatterbox?
and the web crawler heard nothing...

How do I use this?Last hourOther CB clients
Other Users?
Others learning in the Monastery: (6)
As of 2024-04-18 13:19 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    No recent polls found