Merge pull request #1456 from dcdenu4/task/1455-HQ-threat-table-desc

Clarify threat table column about section in model spec.
natcap · Dec 4, 2023 · 79f128a · 79f128a
2 parents 9ecd48c + 229e3b6
commit 79f128a
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 11 deletions.
diff --git a/HISTORY.rst b/HISTORY.rst
@@ -68,6 +68,11 @@ Unreleased Changes
     * Fixed a bug where the model would crash when processing a float type
       bathymetry raster with no nodata value.
       https://github.com/natcap/invest/issues/992
+* Habitat Quality
+    * Updated the threat table column description to clarify that the threat
+      table columns: ``cur_path``, ``fut_path``, and ``base_path`` are meant
+      to be file system path strings.
+      https://github.com/natcap/invest/issues/1455
 * NDR
     * Fixing an issue where minor geometric issues in the watersheds input
       (such as a ring self-intersection) would raise an error in the model.

diff --git a/src/natcap/invest/habitat_quality.py b/src/natcap/invest/habitat_quality.py
@@ -118,29 +118,33 @@
                     "type": "raster",
                     "bands": {1: {"type": "ratio"}},
                     "about": gettext(
-                        "Map of the threat's distribution in the current "
-                        "scenario. Each pixel value is the relative intensity "
-                        "of the threat at that location. ")
+                        "Path to a raster of the threat's "
+                        "distribution in the current scenario. Each pixel "
+                        "value in this raster is the relative intensity "
+                        "of the threat at that location, with values between "
+                        "0 and 1.")
                 },
                 "fut_path": {
                     "required": "lulc_fut_path",
                     "type": "raster",
                     "bands": {1: {"type": "ratio"}},
                     "about": gettext(
-                        "Map of the threat's distribution in the future "
-                        "scenario. Each pixel value is the relative intensity "
-                        "of the threat at that location. "
-                        "Required if Future LULC is provided.")
+                        "Path to a raster of the threat's "
+                        "distribution in a future scenario. Each pixel "
+                        "value in this raster is the relative intensity "
+                        "of the threat at that location, with values between "
+                        "0 and 1.")
                 },
                 "base_path": {
                     "required": "lulc_bas_path",
                     "type": "raster",
                     "bands": {1: {"type": "ratio"}},
                     "about": gettext(
-                        "Map of the threat's distribution in the baseline "
-                        "scenario. Each pixel value is the relative intensity "
-                        "of the threat at that location. "
-                        "Required if Baseline LULC is provided.")
+                        "Path to a raster of the threat's "
+                        "distribution in the baseline scenario. Each pixel "
+                        "value in this raster is the relative intensity "
+                        "of the threat at that location, with values between "
+                        "0 and 1. Required if Baseline LULC is provided.")
                 }
             },
             "about": gettext(