Explicitly document that cmp_ok() passes when the comparision is true.

Signed-off-by: Michael G. Schwern <schwern@pobox.com> For #141
Test-More · Apr 9, 2012 · a6a80f8 · a6a80f8
1 parent 9d2eba3
commit a6a80f8
Showing 1 changed file with 3 additions and 2 deletions.
diff --git a/lib/Test/More.pm b/lib/Test/More.pm
@@ -440,8 +440,9 @@ sub unlike ($$;$) {
 
   cmp_ok( $got, $op, $expected, $test_name );
 
-Halfway between ok() and is() lies cmp_ok().  This allows you to
-compare two arguments using any binary perl operator.
+Halfway between C<ok()> and C<is()> lies C<cmp_ok()>.  This allows you
+to compare two arguments using any binary perl operator.  The test
+passes if the comparison is true and fails otherwise.
 
     # ok( $got eq $expected );
     cmp_ok( $got, 'eq', $expected, 'this eq that' );