Document set_state using the state object by reference

ExFlo · May 9, 2015 · a406ce9 · a406ce9
1 parent 55e43d1
commit a406ce9
Showing 1 changed file with 1 addition and 1 deletion.
diff --git a/src/jstree.js b/src/jstree.js
@@ -3157,7 +3157,7 @@
 		 * sets the state of the tree. Used internally.
 		 * @name set_state(state [, callback])
 		 * @private
-		 * @param {Object} state the state to restore
+		 * @param {Object} state the state to restore. Keep in mind this object is passed by reference and jstree will modify it.
 		 * @param {Function} callback an optional function to execute once the state is restored.
 		 * @trigger set_state.jstree
 		 */