From 493d2fb138ba64faf795e1b4c01fd4f0d49075fc Mon Sep 17 00:00:00 2001
From: Ben Harris <bjh21@bjh21.me.uk>
Date: Mon, 5 Dec 2022 12:49:51 +0000
Subject: [PATCH] Devel docs: make it clear that decode_ui() gets a new game_ui

At least one puzzle does no actual decoding in decode_ui, but does
re-initialise some fields.  This is unnecessary because the mid-end only
calls decode_ui() with a game_ui it just allocated using new_ui().
---
 devel.but | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/devel.but b/devel.but
index 283e48c..4b7988a 100644
--- a/devel.but
+++ b/devel.but
@@ -890,8 +890,8 @@ source.)
 \c void (*decode_ui)(game_ui *ui, const char *encoding);
 
 This function parses a string previously output by \cw{encode_ui()},
-and writes the decoded data back into the provided \c{game_ui}
-structure.
+and writes the decoded data back into the freshly-created \c{game_ui}
+structure provided.
 
 \S{backend-changed-state} \cw{changed_state()}