Merge pull request #1600 from danforthcenter/add-verbose-warn

Update warn to utilize the verbose global parameter

Author: nfahlgren

plantcv/plantcv/warn.py

@@ -1,14 +1,21 @@
 # Warnings handling
 
 import sys
+from plantcv.plantcv import params
 
 
 def warn(warning):
-    """Print out warning message
+    """Print a warning message to stderr.
 
-    Inputs:
-    warning = warning message text
+    Parameters
+    ----------
+    warning : str
+        Warning message to print.
 
-    :param warning: str
+    Returns
+    -------
+    None
+        Function does not return anything.
     """
-    print(f"Warning: {warning}", file=sys.stderr)
+    if params.verbose:
+        print(f"Warning: {warning}", file=sys.stderr)

tests/plantcv/test_warn.py

@@ -0,0 +1,7 @@
+from plantcv.plantcv import warn
+
+
+def test_warn():
+    """Test for PlantCV."""
+    warn("This is a warning message.")
+    assert True