Add note regarding connectivity

open-AIMS · Feb 1, 2024 · b03c234 · b03c234
1 parent f795e83
commit b03c234
Showing 1 changed file with 4 additions and 3 deletions.
diff --git a/src/ecosystem/connectivity.jl b/src/ecosystem/connectivity.jl
@@ -26,9 +26,10 @@ NOTE: Transposes transitional probability matrix if `swap == true`
 
 # Returns
 NamedTuple:
-- `conn` : Matrix, containing the connectivity for all sites
-- `truncated` : ID of sites removed
-- `site_ids` : ID of sites kept
+- `conn` : Matrix, containing the connectivity for all locations.
+           Accounts for larvae which do not settle, so rows are not required to sum to 1
+- `truncated` : ID of locations removed
+- `site_ids` : ID of locations kept
 """
 function site_connectivity(
     file_loc::String,