Docs updates for #882 (JSObserver formatting strings)
This commit is contained in:
@@ -294,7 +294,7 @@ the form ``key = value``. Two items take a different form:, ``worlds`` and
|
|||||||
|
|
||||||
* ``messages=dict(totalTiles=<string>, renderCompleted=<string>, renderProgress=<string>)``
|
* ``messages=dict(totalTiles=<string>, renderCompleted=<string>, renderProgress=<string>)``
|
||||||
Customises messages displayed in browser. All three messages must be
|
Customises messages displayed in browser. All three messages must be
|
||||||
defined as follows:
|
defined similar to the following:
|
||||||
|
|
||||||
* ``totalTiles="Rendering %d tiles"``
|
* ``totalTiles="Rendering %d tiles"``
|
||||||
The ``%d`` format string will be replaced with the total number of
|
The ``%d`` format string will be replaced with the total number of
|
||||||
@@ -304,9 +304,9 @@ the form ``key = value``. Two items take a different form:, ``worlds`` and
|
|||||||
The three format strings will be replaced with the number of hours.
|
The three format strings will be replaced with the number of hours.
|
||||||
minutes and seconds taken to complete this render.
|
minutes and seconds taken to complete this render.
|
||||||
|
|
||||||
* ``renderProgress="Rendered %d of %d tiles (%d%%)"``
|
* ``renderProgress="Rendered %d of %d tiles (%d%% ETA:%s)""``
|
||||||
The three format strings will be replaced with the number of tiles
|
The four format strings will be replaced with the number of tiles
|
||||||
completed, the total number of tiles and the percentage complete
|
completed, the total number of tiles, the percentage complete, and the ETA.
|
||||||
|
|
||||||
Format strings are explained here: http://docs.python.org/library/stdtypes.html#string-formatting
|
Format strings are explained here: http://docs.python.org/library/stdtypes.html#string-formatting
|
||||||
All format strings must be present in your custom messages.
|
All format strings must be present in your custom messages.
|
||||||
|
|||||||
Reference in New Issue
Block a user