chiark / gitweb /
docs: Document die numeric labels
authorIan Jackson <ijackson@chiark.greenend.org.uk>
Sun, 15 May 2022 15:06:27 +0000 (16:06 +0100)
committerIan Jackson <ijackson@chiark.greenend.org.uk>
Sun, 15 May 2022 20:41:08 +0000 (21:41 +0100)
Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>
docs/gamespec.rst

index d92908ccf1acbe950667e467a7b701760e90791a..4a390cc7cfa0e44754debd2ad2520d28ac721ceb 100644 (file)
@@ -339,7 +339,10 @@ Parameters:
    [inner piece spec, as dictionary; required].
 
  * ``labels``: Text strings to superimpose on the image.
-   [list of strings; optional]
+
+    - [list of strings] One string per face.
+    - [list of two numbers] Label faces numerically (inclusive).
+    - [single number] Label faces numerically from 1 to n (inclusive).
 
  * ``cooldown``: Duration of the cooldown time.
    [duration - number(s) with units; default "4s"]