updates docs

benchmark-urbanism · Nov 28, 2024 · 244c98a · 244c98a
1 parent 35b38e4
commit 244c98a
Show file tree

Hide file tree

Showing 5 changed files with 37 additions and 2 deletions.
diff --git a/docs/public/images/graph_clean.png b/docs/public/images/graph_clean.png
diff --git a/docs/public/images/graph_raw.png b/docs/public/images/graph_raw.png
diff --git a/docs/src/pages/rustalgos/rustalgos.md b/docs/src/pages/rustalgos/rustalgos.md
@@ -2807,12 +2807,12 @@ datapoints are not located with high spatial precision.
 
 
 
-<span class="name">node_lives</span><span class="annotation">: list[bool]</span>
+<span class="name">node_xs</span><span class="annotation">: list[float]</span>
 
 
 
 
-<span class="name">node_xs</span><span class="annotation">: list[float]</span>
+<span class="name">node_lives</span><span class="annotation">: list[bool]</span>
 
 
 

diff --git a/docs/src/pages/tools/graphs.md b/docs/src/pages/tools/graphs.md
@@ -123,6 +123,11 @@ side-effects as a function of varied node intensities when computing network cen
     <span class="pc">:</span>
     <span class="pa"> int = 100</span>
   </div>
+  <div class="param">
+    <span class="pn">remove_deadend_tunnels</span>
+    <span class="pc">:</span>
+    <span class="pa"> bool = True</span>
+  </div>
   <span class="pt">)</span>
 </div>
 </div>
@@ -160,6 +165,16 @@ side-effects as a function of varied node intensities when computing network cen
  Remove disconnected components with fewer nodes than specified by this parameter. Defaults to 100. Set to 0 to keep all disconnected components.</div>
 </div>
 
+<div class="param-set">
+  <div class="def">
+    <div class="name">remove_deadend_tunnels</div>
+    <div class="type">bool</div>
+  </div>
+  <div class="desc">
+
+ Remove dead-end tunnels. Default of True.</div>
+</div>
+
 ### Returns
 <div class="param-set">
   <div class="def">
@@ -346,6 +361,11 @@ side-effects as a function of varied node intensities when computing network cen
     <span class="pc">:</span>
     <span class="pa"> int = 100</span>
   </div>
+  <div class="param">
+    <span class="pn">max_foot_tunnel_length</span>
+    <span class="pc">:</span>
+    <span class="pa"> int = 50</span>
+  </div>
   <span class="pt">)</span>
 </div>
 </div>
@@ -383,6 +403,16 @@ side-effects as a function of varied node intensities when computing network cen
  Maximum self loop length to permit for a given edge.</div>
 </div>
 
+<div class="param-set">
+  <div class="def">
+    <div class="name">max_foot_tunnel_length</div>
+    <div class="type">int</div>
+  </div>
+  <div class="desc">
+
+ Maximum tunnel length to permit for non motorised edges.</div>
+</div>
+
 ### Returns
 <div class="param-set">
   <div class="def">

diff --git a/docs/src/pages/tools/util.md b/docs/src/pages/tools/util.md
@@ -537,6 +537,11 @@ layout: ../../layouts/PageLayout.astro
 
 
 
+<span class="name">levels</span>
+
+
+
+
 <div class="function">
 
 ## gather_edge_info
Original file line number	Diff line number	Diff line change
Expand Up		@@ -537,6 +537,11 @@ layout: ../../layouts/PageLayout.astro



		<span class="name">levels</span>




		<div class="function">

		## gather_edge_info
Expand Down