add reg/unreg flow disclaimer to API ref text

DOI-USGS · Oct 2, 2023 · ce3b823 · ce3b823
1 parent a26353b
commit ce3b823
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/hyswap/plots.py b/hyswap/plots.py
@@ -279,6 +279,10 @@ def plot_duration_hydrograph(percentiles_by_day, df, data_col, doy_col,
     minimum discharge recorded for each day. This function, however, allows
     the user to plot a custom list of percentiles.
 
+    Note: For some streams, flow statistics may have been computed from
+    mixed regulated and unregulated flows; this can affect depictions
+    of flow conditions.
+
     Parameters
     ----------
     percentiles_by_day : pandas.DataFrame
@@ -422,6 +426,10 @@ def plot_cumulative_hydrograph(cumulative_percentiles, target_years,
     of record; the mean-daily cumulative flow for each day; the minimum
     cumulative discharge during recorded for each day.
 
+    Note: For some streams, flow statistics may have been computed from
+    mixed regulated and unregulated flows; this can affect depictions
+    of flow conditions.
+
     Parameters
     ----------
     cumulative_percentiles : pandas.DataFrame