sway

commit 3c81a900b766dd2c049ba7af6e603805893e0926
parent d7169ee7ffd45318125dbe3013aadbd1482a3e5f
Author: Ryan Dwyer <ryandwyer1@gmail.com>
Date:   Fri, 29 Jun 2018 19:52:31 +1000

Add comment about usage to arrange_windows declaration

Diffstat:
M
include/sway/tree/arrange.h
 | 
4
++++

1 file changed, 4 insertions(+), 0 deletions(-)
diff --git 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);