aboutsummaryrefslogtreecommitdiff
path: root/include/sway/tree
diff options
context:
space:
mode:
Diffstat (limited to 'include/sway/tree')
-rw-r--r--include/sway/tree/arrange.h4
1 files changed, 4 insertions, 0 deletions
diff --git a/include/sway/tree/arrange.h b/include/sway/tree/arrange.h
index 6c8c0dba..58235642 100644
--- a/include/sway/tree/arrange.h
+++ b/include/sway/tree/arrange.h
@@ -16,6 +16,10 @@ void add_gaps(struct sway_container *c);
*
* Use this function if you need to arrange multiple sections of the tree in one
* transaction.
+ *
+ * You must set the desired state of the container before calling
+ * arrange_windows, then don't change any state-tracked properties in the
+ * container until you've called transaction_commit.
*/
void arrange_windows(struct sway_container *container,
struct sway_transaction *transaction);