added a comment about crossing edges in large trees

dchartash · Oct 30, 2014 · 0ca1bf3 · 0ca1bf3
1 parent 9d7de85
commit 0ca1bf3
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 1 deletion.
diff --git a/util/template_visualize_rst_tree.html b/util/template_visualize_rst_tree.html
@@ -61,7 +61,7 @@
 
   tree.numLeaves = 0;
   if ( !tree.children ) {
-    tree.numLeaves = 1;
+    tree.numLeaves = 1;  // count self as a leaf
   }
 
   for (idx in tree.children) {

diff --git a/util/visualize_rst_tree.py b/util/visualize_rst_tree.py
@@ -10,6 +10,10 @@
 
 For the D3.js license, see LICENSE_d3.txt or
 https://github.com/mbostock/d3/blob/master/LICENSE for the D3.js license.
+
+Note: on very large trees, edges may cross.  This appears to be a feature of
+the layout algorithm.  It could be avoided by having curved edges, but I don't
+think functionality for computing the necessary paths is available.
 '''
 
 import argparse