From 1c7b5a0a2332828eb232890c8f2bbcb19f13d0c1 Mon Sep 17 00:00:00 2001 From: Ian Jackson Date: Wed, 22 Jun 2022 00:05:31 +0100 Subject: [PATCH] docs: Correct `desc_template` description Signed-off-by: Ian Jackson --- CHANGELOG.md | 6 ++++++ docs/shapelibs.rst | 13 +++++++------ 2 files changed, 13 insertions(+), 6 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index a266e8ad..9d47bf49 100644 --- 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 5747399f..d2ff89f9 100644 --- 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 -- 2.30.2