note about stopHere for update() in the readme

ljharb · Jun 11, 2011 · 18f3e27 · 18f3e27
1 parent 1d31897
commit 18f3e27
Showing 1 changed file with 5 additions and 2 deletions.
diff --git a/README.markdown b/README.markdown
@@ -102,11 +102,14 @@ this.circular
 If the node equals one of its parents, the `circular` attribute is set to the
 context of that parent and the traversal progresses no deeper.
 
-this.update(value)
-------------------
+this.update(value, stopHere=false)
+----------------------------------
 
 Set a new value for the present node.
 
+All the elements in `value` will be recursively traversed unless `stopHere` is
+true.
+
 this.remove()
 -------------