From ff3be31b9e47a65b96f305af07aca2866f0c01cd Mon Sep 17 00:00:00 2001
From: Ben Campbell <ben@scumways.com>
Date: Sat, 18 Aug 2018 10:49:34 +1200
Subject: [PATCH] add some notes to uiTableSelection

---
 ui.h | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/ui.h b/ui.h
index 1064e2aa..23405b2d 100644
--- a/ui.h
+++ b/ui.h
@@ -1463,6 +1463,9 @@ _UI_EXTERN void uiTableAppendButtonColumn(uiTable *t,
 _UI_EXTERN void uiTableOnSelectionChanged(uiTable *t, void (*f)(uiTable *t, void *data), void *data);
 
 // uiTableSelection holds an array of row indexes for a table.
+// it's safe to fiddle with the Items data in place (eg a caller
+// might want to sort them - that's ok). But probably best not to
+// change NumItems or try to reallocate Items.
 typedef struct uiTableSelection uiTableSelection;
 struct uiTableSelection
 {