docs: Correct `desc_template` description

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

diff --git a/CHANGELOG.md b/CHANGELOG.md
index a266e8adacd5b13553cff8f4544f7e4e77261329..9d47bf4984f1eecc2350abc4115935cc8672ad0f 100644 (file)
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -53,6 +53,12 @@ Game client UI fixes
 
  * Fix minor bugs in mouse click handling corner cases.
 
+Documentation
+-------------
+
+ * Correct the description of the shapelib group parameter `desc_template`.
+   (Previously this wrongly said the parameter was `desc`.)
+
 Demo (testing) game changes
 ---------------------------
 

diff --git a/docs/shapelibs.rst b/docs/shapelibs.rst
index 5747399f1f4645ca2010e07c84ccc535bb487794..d2ff89f9a99ea03ceab12d11a85c1a5f9edb928c 100644 (file)
--- a/docs/shapelibs.rst
+++ b/docs/shapelibs.rst
@@ -378,12 +378,13 @@ Other group parameters
    have a ``map`` entry which is a sub-sub-dict mapping input colours
    (strings in ``#rrggbb`` format) to output colours.
 
- * ``desc`` [string: template]: : If specified, provides a template
-   for the description, to allow formulaic descriptions of pieces in
-   this group.  The string specified by ``desc`` must contain ``${desc}``
-   exactly once; that will be replaced with the description calculated
-   according to the other rules.  (``${desc}`` substitution happens
-   after ``${colour}`` substitution.)
+ * ``desc_template`` [string: template]: : If specified, provides a
+   template for the description, to allow formulaic descriptions of
+   pieces in this group.  The string specified by ``desc_template``
+   must contain ``${desc}`` exactly once; that will be replaced with
+   the description calculated according to the other rules.
+   (``${desc}`` substitution happens after ``${colour}``
+   substitution.)
 
  * ``occulted`` [dict, contents depend on ``occulted.method``].  If
    specified, these pieces be occulted.  For example, when a player