Skip to content

Commit

Permalink
Merge pull request #6826 from ThomasWaldmann/fix-progress-percent-doc…
Browse files Browse the repository at this point in the history
…s-1.1

docs: json progress_percent: some values are optional, fixes #4074
  • Loading branch information
ThomasWaldmann committed Jul 2, 2022
2 parents 7a29c11 + 7b908b5 commit 85f8acd
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions docs/internals/frontends.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down

0 comments on commit 85f8acd

Please sign in to comment.