From b6f0f14dd3d950719f9d435cf4a958aef30e7d22 Mon Sep 17 00:00:00 2001 From: Felix Fontein Date: Tue, 19 Nov 2019 15:46:59 +0100 Subject: [PATCH] Document diff. (#64888) --- .../rst/reference_appendices/common_return_values.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/docsite/rst/reference_appendices/common_return_values.rst b/docs/docsite/rst/reference_appendices/common_return_values.rst index 2749526550a..bca1ef970ad 100644 --- 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.