The text tells you what is being tested, not how it is being tested. I quite often have tests which rely on the results of previous tests, or which perform convoluted backflips to massage my objects' state into something needed for the next test. This sort of thing, I have realised, must be commented. Not because it's useful to you, as you should be relying on the module's documentation and not its tests to see what it does and how to use it. No, the tests should be commented for the same reason that the module being tested should have comments - because it makes it easier for me to fix bugs or add functionality later.

Expect me to finish fixing all my test code ... never.

In reply to Re^2: document your test files by DrHyde
in thread document your test files by shmem

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


  • Posts are HTML formatted. Put <p> </p> tags around your paragraphs. Put <code> </code> tags around your code and data!
  • Titles consisting of a single word are discouraged, and in most cases are disallowed outright.
  • Read Where should I post X? if you're not absolutely sure you're posting in the right place.
  • Please read these before you post! —
  • Posts may use any of the Perl Monks Approved HTML tags:
    a, abbr, b, big, blockquote, br, caption, center, col, colgroup, dd, del, details, div, dl, dt, em, font, h1, h2, h3, h4, h5, h6, hr, i, ins, li, ol, p, pre, readmore, small, span, spoiler, strike, strong, sub, summary, sup, table, tbody, td, tfoot, th, thead, tr, tt, u, ul, wbr
  • You may need to use entities for some characters, as follows. (Exception: Within code tags, you can put the characters literally.)
            For:     Use:
    & &amp;
    < &lt;
    > &gt;
    [ &#91;
    ] &#93;
  • Link using PerlMonks shortcuts! What shortcuts can I use for linking?
  • See Writeup Formatting Tips and other pages linked from there for more info.