0

Docs updates for #882 (JSObserver formatting strings)

This commit is contained in:
Andrew Chin
2013-05-07 21:34:31 -04:00
parent 0f017f6b51
commit 478d44f480

View File

@@ -294,7 +294,7 @@ the form ``key = value``. Two items take a different form:, ``worlds`` and
* ``messages=dict(totalTiles=<string>, renderCompleted=<string>, renderProgress=<string>)``
Customises messages displayed in browser. All three messages must be
defined as follows:
defined similar to the following:
* ``totalTiles="Rendering %d tiles"``
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.
minutes and seconds taken to complete this render.
* ``renderProgress="Rendered %d of %d tiles (%d%%)"``
The three format strings will be replaced with the number of tiles
completed, the total number of tiles and the percentage complete
* ``renderProgress="Rendered %d of %d tiles (%d%% ETA:%s)""``
The four format strings will be replaced with the number of tiles
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
All format strings must be present in your custom messages.