Document diff. (#64888)

2019-11-19 15:46:59 +01:00 · 2019-11-19 15:46:59 +01:00 · b6f0f14dd3
commit b6f0f14dd3
parent 09aebf33e4
1 changed files with 5 additions and 0 deletions
--- a/docs/docsite/rst/reference_appendices/common_return_values.rst
+++ b/docs/docsite/rst/reference_appendices/common_return_values.rst
@ -24,6 +24,11 @@ changed
 ```````
 A boolean indicating if the task had to make changes.

+diff
+````
+
+Information on differences between the previous and current state. Often a dictionary with entries ``before`` and ``after``, which will then be formatted by the callback plugin to a diff view.
+
 failed
 ``````
 A boolean that indicates if the task was failed or not.