浏览代码

Merge pull request #6825 from ThomasWaldmann/fix-progress-percent-docs-master

docs: json progress_percent: some values are optional, fixes #4074
TW 2 年之前
父节点
当前提交
dff33f61d7
共有 1 个文件被更改,包括 4 次插入2 次删除
  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*.
         can have this property set to *true*.
     message
     message
         A formatted progress message, this will include the percentage and perhaps other information
         A formatted progress message, this will include the percentage and perhaps other information
+        (absent for finished == true)
     current
     current
-        Current value (always less-or-equal to *total*)
+        Current value (always less-or-equal to *total*, absent for finished == true)
     info
     info
         Array that describes the current item, may be *null*, contents depend on *msgid*
         Array that describes the current item, may be *null*, contents depend on *msgid*
+        (absent for finished == true)
     total
     total
-        Total value
+        Total value (absent for finished == true)
     time
     time
         Unix timestamp (float)
         Unix timestamp (float)