From e17388d3b2d1521d963bf9dd9e7a4ba5ba9bb09d Mon Sep 17 00:00:00 2001
From: Kelly Brazil <kellyjonbrazil@gmail.com>
Date: Tue, 12 Nov 2019 14:19:40 -0800
Subject: [PATCH] doc update

---
 docs/utils.md | 22 +++++++++++++++++++++-
 jc/utils.py   | 26 +++++++++++++++++++++++---
 2 files changed, 44 insertions(+), 4 deletions(-)

diff --git a/docs/utils.md b/docs/utils.md
index b3fe7677..6439842f 100644
--- a/docs/utils.md
+++ b/docs/utils.md
@@ -4,19 +4,39 @@ jc - JSON CLI output utility utils
 ```python
 warning_message(message)
 ```
+
 Prints a warning message for non-fatal issues
+
+Parameters:
+
+    message         (string) text of message
+
+Returns:
+
+    no return, just prints output to STDERR
+
 ## error_message
 ```python
 error_message(message)
 ```
+
 Prints an error message for fatal issues
+
+Parameters:
+
+    message         (string) text of message
+
+Returns:
+
+    no return, just prints output to STDERR
+
 ## compatibility
 ```python
 compatibility(mod_name, compatible)
 ```
 Checks for the parser's compatibility with the running OS platform.
 
-Arguments:
+Parameters:
 
     mod_name        (string) __name__ of the calling module
 
diff --git a/jc/utils.py b/jc/utils.py
index 87c3309a..2b5b72b0 100644
--- a/jc/utils.py
+++ b/jc/utils.py
@@ -4,7 +4,17 @@ import sys
 
 
 def warning_message(message):
-    """Prints a warning message for non-fatal issues"""
+    """
+    Prints a warning message for non-fatal issues
+
+    Parameters:
+
+        message         (string) text of message
+
+    Returns:
+
+        no return, just prints output to STDERR
+    """
 
     error_string = f'''
     jc:  Warning - {message}
@@ -13,7 +23,17 @@ def warning_message(message):
 
 
 def error_message(message):
-    """Prints an error message for fatal issues"""
+    """
+    Prints an error message for fatal issues
+
+    Parameters:
+
+        message         (string) text of message
+
+    Returns:
+
+        no return, just prints output to STDERR
+    """
     
     error_string = f'''
     jc:  Error - {message}
@@ -24,7 +44,7 @@ def error_message(message):
 def compatibility(mod_name, compatible):
     """Checks for the parser's compatibility with the running OS platform.
     
-    Arguments:
+    Parameters:
 
         mod_name        (string) __name__ of the calling module