Skip to content
Browse files

Better document the eq_or_diff options.

  • Loading branch information...
1 parent b8c5811 commit a6f4779180c0d457337255c0e0e2595557ef7b4a @Ovid committed Apr 16, 2011
Showing with 14 additions and 2 deletions.
  1. +14 −2 lib/Test/Differences.pm
View
16 lib/Test/Differences.pm
@@ -143,15 +143,27 @@ YMMV.
=head1 OPTIONS
-There is currently only one option: "context". This allows you to
-control the amount of context shown:
+The options to C<eq_or_diff> give some fine-grained control over the output.
+
+=over 4
+
+=item * C<context>
+
+This allows you to control the amount of context shown:
eq_or_diff $got, $expected, $name, { context => 50000 };
will show you lots and lots of context. Normally, eq_or_diff() uses
some heuristics to determine whether to show 3 lines of context (like
a normal unified diff) or 25 lines.
+=item * C<data_type>
+
+C<text> or C<data>. See C<eq_or_diff_text> and C<eq_or_diff_data> to
+understand this. You can usually ignore this.
+
+=back
+
=head1 DIFF STYLES
For extremely long strings, a table diff can wrap on your screen and be hard

0 comments on commit a6f4779

Please sign in to comment.
Something went wrong with that request. Please try again.