In many modules I see people embed the version number in the POD so the reader will know. This can quickly get out of sync with the real version number.
Write a test. Or a little script that either synchronizes, or increments version numbers.
Would it be better/possible to have perldoc extract the version number of a module - when displaying the docs of a module - and show that along the documentation?
Probably not. But you can always do something like (untested):
{no warnings; <<'=pod'}
=pod
our $VERSION = '1.2.3';
=pod
=cut
The first =pod tricks most, if not all, podlators into thinking POD starts. They're all fooled, and perl knows. The second =pod starts the real POD section. =cut syncs perl and the podlators.
-
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.
|