Merge pull request Codeception#280 from fkupper/patch-2

Naktibalda · web-flow · commit 46b255aaca7c · 2020-07-06T17:48:33.000+03:00
Update snapshot readme
diff --git a/docs/09-Data.md b/docs/09-Data.md
@@ -366,7 +366,26 @@ On next execution the obtained data will be compared with previously saved snaps
 > To update a snapshot with a new data run tests in `--debug` mode.
 
 By default Snapshot uses `assertEquals` assertion, however this can be customized by overriding `assertData` method.
+
+### Failed assertion output
+
+The assertion performed by `assertData` will not display the typical diff output from `assertEquals` or any customized failed assertion.
+To have the diff displayed when running tests, you can call the snapshot method `shouldShowDiffOnFail`:
+
+{% highlight php %}
+
+<?php
+public function testCategoriesAreTheSame(\AcceptanceTester $I, \Snapshot\Categories $snapshot)
+{
+    $I->amOnPage('/categories');
+    // I want to see the diff in case the snapshot data changes
+    $snapshot->shouldShowDiffOnFail();
+    $snapshot->assert();
+}
+
+{% endhighlight %}
   
+If ever needed, the diff output can also be omitted by calling `shouldShowDiffOnFail(false)`.
 
 ## Conclusion
 
@@ -378,4 +397,4 @@ to operate with database through a data abstraction layer, and use the DataFacto
 
 
 * **Next Chapter: [APITesting >](/docs/10-APITesting)**
-* **Previous Chapter: [< Customization](/docs/08-Customization)**
+* **Previous Chapter: [< Customization](/docs/08-Customization)**
