From: Ian Jackson <ijackson@chiark.greenend.org.uk>
Date: Sun, 15 May 2022 15:06:27 +0000 (+0100)
Subject: docs: Document die numeric labels
X-Git-Tag: otter-1.1.0~105
X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?a=commitdiff_plain;h=e350e3ebe95fa3ce7e6081884c9125bb9906d974;p=otter.git

docs: Document die numeric labels

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>
---

diff --git a/docs/gamespec.rst b/docs/gamespec.rst
index d92908cc..4a390cc7 100644
--- a/docs/gamespec.rst
+++ b/docs/gamespec.rst
@@ -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"]