Browse Source

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.
Thomas Waldmann 2 years ago
parent
commit
ea4ed6b98f
1 changed files with 4 additions and 2 deletions
  1. 4 2
      docs/internals/frontends.rst

+ 4 - 2
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)