The problem with that is that it's possible for the docs to be clear, seem complete, and describe friendly syntax... and be wrong
Which of course a doc review would not highlight. But normal testing and use would. I'm not advocating POD review as a replacement for functional testing, but as a way to get more people involved in distribution QA in a way that is easier and more accessible than performing full blown testing, and getting a 'first pass' done on a wider range of modules. After all, full testing on every module on CPAN is well nigh impossible, but if we could get a POD review on a wider range, that would be better than nothing.
VGhpcyBtZXNzYWdlIGludGVudGlvbmFsbHkgcG9pbnRsZXNz
-
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.
|