Monday, January 07, 2013

How to write a test description | Ovid [blogs.perl.org]

How to write a test description | Ovid [blogs.perl.org]: "If you were to read the TAP grammar, you would see the following line:

test ::= status positiveInteger? description? directive?
What that means is that a test line of TAP (if you read the rest of the grammar) must have an "ok" or "not ok" bit, followed by an optional test number (in practice, it's almost always there) and a test description (the directive refers to "skip" or "todo" tests). Sadly, many people don't pay attention to the powerful benefits of the description. A bad description may as well be left off; a good description is the difference between a pile of confusing code and documentation."

'via Blog this'