Beefy Boxes and Bandwidth Generously Provided by pair Networks
Do you know where your variables are?
 
PerlMonks  

comment on

( [id://3333]=superdoc: print w/replies, xml ) Need Help??
Hi!

I use to include a VERSION section in the main module of the distributions uploaded to CPAN, but this comes at the risk of forgetting to update the number.

Over time, I adopted different strategies, ranging from doing it manually (guess what happened), to using Dist::Zilla all the way down to Pod::Weaver (which I really never liked), to switching to Milla and inserting a custom mangling script in an AfterBuild step (example dist.ini and mangling script if you're curious). This mostly works, but it's giving me issues in a corner case in Travis-CI which brought me to ask myself whether I still want it or not.

I somehow like the idea of including that section, so that anyone looking at the documentation can get an idea of what docs they are reading without resorting to hoop jumping (my favorite incantation being perldoc -m Module::Name and then looking for $VERSION). Spending additional effort on my custom mangling script is not something that attracts me too much. So I'd ask your advice about:

  • does including a VERSION section really provide value in your opinion?
  • is there any "evident" way to do automate that using Milla? Alas, it seems that miyagawa does not usually include that section (not in the ones I sampled, anyway), so there's no evident way for me to do this!

Thanks for any feedback!

perl -ple'$_=reverse' <<<ti.xittelop@oivalf

Io ho capito... ma tu che hai detto?

In reply to VERSION section in POD by polettix

Title:
Use:  <p> text here (a paragraph) </p>
and:  <code> code here </code>
to format your post; it's "PerlMonks-approved HTML":



  • Are you posting in the right place? Check out Where do I post X? to know for sure.
  • Posts may use any of the Perl Monks Approved HTML tags. Currently these include the following:
    <code> <a> <b> <big> <blockquote> <br /> <dd> <dl> <dt> <em> <font> <h1> <h2> <h3> <h4> <h5> <h6> <hr /> <i> <li> <nbsp> <ol> <p> <small> <strike> <strong> <sub> <sup> <table> <td> <th> <tr> <tt> <u> <ul>
  • Snippets of code should be wrapped in <code> tags not <pre> tags. In fact, <pre> tags should generally be avoided. If they must be used, extreme care should be taken to ensure that their contents do not have long lines (<70 chars), in order to prevent horizontal scrolling (and possible janitor intervention).
  • Want more info? How to link or How to display code and escape characters are good places to start.
Log In?
Username:
Password:

What's my password?
Create A New User
Domain Nodelet?
Chatterbox?
and the web crawler heard nothing...

How do I use this?Last hourOther CB clients
Other Users?
Others exploiting the Monastery: (5)
As of 2024-04-25 08:59 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    No recent polls found