Document the hybrid parameter of FlowObject

TopoToolbox · Dec 6, 2024 · 1f1580a · 1f1580a
1 parent 36405d1
commit 1f1580a
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/src/topotoolbox/flow_object.py b/src/topotoolbox/flow_object.py
@@ -31,6 +31,10 @@ def __init__(self, grid: GridObject,
             indicate pixels that should be fixed to their values in the
             original DEM and values of 0 indicate pixels that should be
             filled.
+        hybrid: bool, optional
+            Should hybrid reconstruction algorithm be used to fill
+            sinks? Defaults to True. Hybrid reconstruction is faster
+            but requires additional memory be allocated for a queue.
 
         Notes
         -----