Improve docs

skuzzle · Nov 14, 2022 · 23a9a27 · 23a9a27
1 parent 6d8d8c6
commit 23a9a27
Showing 1 changed file with 7 additions and 1 deletion.
diff --git a/snapshot-tests-core/src/main/java/de/skuzzle/test/snapshots/data/text/TextSnapshot.java b/snapshot-tests-core/src/main/java/de/skuzzle/test/snapshots/data/text/TextSnapshot.java
@@ -25,7 +25,13 @@ public final class TextSnapshot implements StructuredDataProvider {
 
     /**
      * Take Snapshots using {@link Object#toString()} and compare the results using a
-     * generic String diff algorithm. Comparison ignores whitespace changes of any kind.
+     * generic String diff algorithm. Comparison ignores whitespace changes of any kind
+     * and does not limit the size of the unified diff.
+     * <p>
+     * You can create a more customized text comparison by using {@link #text()} and the
+     * several customization options.
+     *
+     * @see #text()
      */
     public static final StructuredData text = text()
             .withIgnoreWhitespaces(true)