Merge pull request #40 from FluvialGeomorph/document_toolbox

Document toolbox
FluvialGeomorph · Jun 7, 2024 · 4bec5f3 · 4bec5f3
2 parents 0dfa16b + db26dba
commit 4bec5f3
Show file tree

Hide file tree

Showing 5 changed files with 4 additions and 6 deletions.
diff --git a/FluvialGeomorph_31.atbx b/FluvialGeomorph_31.atbx
diff --git a/tools/_03a_ContributingAreaD8.py b/tools/_03a_ContributingAreaD8.py
@@ -18,9 +18,6 @@
 processes             -- The number of processes to use for parallel processing.
 
 Outputs:
-contributing_area_D8  -- an flow accumulation raster using the D* method. Units 
-                         are the linear units of the input DEM. ESRI refers to 
-                         this as a flow accumulation raster. 
 flow_direction_D8     -- A flow direction raster using the D8 method (integer 
                          flow directions). 
 ____________________________________________________________________________"""

diff --git a/tools/_04c_Watersheds.py b/tools/_04c_Watersheds.py
@@ -24,7 +24,7 @@
 points                -- Path to the points feature class.
 point_ID_field        -- Field in the points feature class that contains the 
                          point IDs.
-flow_accumulation     -- Path to the flow accumulation model.
+flow_accumulation     -- Path to the D8 flow accumulation model.
 flow_direction_d8     -- Path to the flow_direction_d8` model (must use 
                          D8 method).
 snap_distance         -- The distance the point will be snapped to find the 

diff --git a/tools/_07_DetrendDEM.py b/tools/_07_DetrendDEM.py
@@ -4,7 +4,8 @@
 Date:                 01/14/2020
 
 Usage:
-This tool is based on the detrending method used in the River Bathymetry Toolkit (RBT) http://essa.com/tools/river-bathymetry-toolkit-rbt/. 
+This tool is based on the detrending method used in the River Bathymetry 
+Toolkit (RBT) http://essa.com/tools/river-bathymetry-toolkit-rbt/. 
 
 Parameters:
 feature_dataset (str) -- Path to the feature dataset.

diff --git a/tools/_15a_XSDimensions.R b/tools/_15a_XSDimensions.R
@@ -19,7 +19,7 @@
 #'
 #'
 #' @return A new cross section feature class with the hydraulic geometry 
-#'      dimensions is added to the attribute table.
+#'      dimensions added to the attribute table.
 #'      
 #' #TODO Create an fluvgeo function to perform this operation
 #'