From 4faa16fe0ddf98659bfa3f852cb1d9b8ff95eb93 Mon Sep 17 00:00:00 2001
From: luk3yx <luk3yx@users.noreply.github.com>
Date: Sat, 23 Nov 2024 05:56:35 +1300
Subject: [PATCH] Clarify behaviour of core.hypertext_escape (#15464)

---
 doc/lua_api.md | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/doc/lua_api.md b/doc/lua_api.md
index b4ef79088..709bf2984 100644
--- a/doc/lua_api.md
+++ b/doc/lua_api.md
@@ -6699,6 +6699,9 @@ Formspec
 * `core.hypertext_escape(string)`: returns a string
     * escapes the characters "\", "<", and ">" to show text in a hypertext element.
     * not safe for use with tag attributes.
+    * this function does not do formspec escaping, you will likely need to do
+      `core.formspec_escape(core.hypertext_escape(string))` if the hypertext is
+      not already being formspec escaped.
 * `core.explode_table_event(string)`: returns a table
     * returns e.g. `{type="CHG", row=1, column=2}`
     * `type` is one of: