From ea4ed6b98f030d28b1b55aa1527a730116f65631 Mon Sep 17 00:00:00 2001 From: Thomas Waldmann Date: Fri, 1 Jul 2022 14:31:23 +0200 Subject: [PATCH] docs: json progress_percent: some values are optional, fixes #4074 in the finished == true message, these are missing: - message - current / total - info This is to be somewhat consistent with #6683 by only providing a minimal set of values for the finished case. The finished messages is primarily intended for cleanup purposes, e.g. clearing the progress display. --- docs/internals/frontends.rst | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/internals/frontends.rst b/docs/internals/frontends.rst index 8ff5ff475..2fc1ab0a6 100644 --- a/docs/internals/frontends.rst +++ b/docs/internals/frontends.rst @@ -90,12 +90,14 @@ progress_percent can have this property set to *true*. message A formatted progress message, this will include the percentage and perhaps other information + (absent for finished == true) current - Current value (always less-or-equal to *total*) + Current value (always less-or-equal to *total*, absent for finished == true) info Array that describes the current item, may be *null*, contents depend on *msgid* + (absent for finished == true) total - Total value + Total value (absent for finished == true) time Unix timestamp (float)