From 2be3824d9ed3942c8229c6617b1ce53a5fc93c56 Mon Sep 17 00:00:00 2001
From: uramer <antonuramer@gmail.com>
Date: Fri, 24 Nov 2023 20:41:54 +0100
Subject: [PATCH] Clarify child element update behavior in the documentation

---
 files/lua_api/openmw/ui.lua | 27 ++++++++++++++++++++++++++-
 1 file changed, 26 insertions(+), 1 deletion(-)

diff --git a/files/lua_api/openmw/ui.lua b/files/lua_api/openmw/ui.lua
index 53ff57d276..451f919077 100644
--- a/files/lua_api/openmw/ui.lua
+++ b/files/lua_api/openmw/ui.lua
@@ -228,10 +228,35 @@
 -- @type Element
 
 ---
--- Refreshes the rendered element to match the current layout state
+-- Refreshes the rendered element to match the current layout state.
+-- Refreshes positions and sizes, but not the layout of the child Elements.
 -- @function [parent=#Element] update
 -- @param self
 
+-- @usage
+-- local child = ui.create {
+--     type = ui.TYPE.Text,
+--     props = {
+--         text = 'child 1',
+--     },
+-- }
+-- local parent = ui.create {
+--     content = ui.content {
+--         child,
+--         {
+--             type = ui.TYPE.Text,
+--             props = {
+--                 text = 'parent 1',
+--             },
+--         }
+--     }
+-- }
+-- -- ...
+-- child.layout.props.text = 'child 2'
+-- parent.layout.content[2].props.text = 'parent 2'
+-- parent:update() -- will show 'parent 2', but 'child 1'
+
+
 ---
 -- Destroys the element
 -- @function [parent=#Element] destroy