trying improved docstrings

dvatterott · Jan 3, 2019 · 7aff424 · 7aff424
1 parent b8cc694
commit 7aff424
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 8 deletions.
diff --git a/predeval/categorical.py b/predeval/categorical.py
@@ -143,7 +143,9 @@ def check_chi2(self, comparison_data=None):
 
         Returns
         -------
-        None
+        (tuple): tuple containing:
+            test_name (str): name of test
+            pass (bool): whether passed test
 
         """
         assert self.assertion_params['chi2_test'], 'Must input or load reference data chi2-test'
@@ -170,8 +172,8 @@ def check_exist(self, comparison_data=None):
 
         Returns
         -------
-        2 item tuple with test name and boolean expressing whether passed test.
-
+        (string, bool)
+            2 item tuple with test name and boolean expressing whether passed test.
         """
         assert self.assertion_params['cat_exists'] is not None,\
             'Must input or load reference minimum'

diff --git a/predeval/continuous.py b/predeval/continuous.py
@@ -175,7 +175,8 @@ def check_min(self, comparison_data=None):
 
         Returns
         -------
-        2 item tuple with test name and boolean expressing whether passed test.
+        (string, bool)
+            2 item tuple with test name and boolean expressing whether passed test.
 
         """
         assert self.assertion_params['minimum'] is not None, 'Must input or load reference minimum'
@@ -197,7 +198,8 @@ def check_max(self, comparison_data=None):
 
         Returns
         -------
-        2 item tuple with test name and boolean expressing whether passed test.
+        (string, bool)
+            2 item tuple with test name and boolean expressing whether passed test.
 
         """
         assert self.assertion_params['maximum'] is not None, 'Must input or load reference maximum'
@@ -219,7 +221,8 @@ def check_mean(self, comparison_data=None):
 
         Returns
         -------
-        2 item tuple with test name and boolean expressing whether passed test.
+        (string, bool)
+            2 item tuple with test name and boolean expressing whether passed test.
 
         """
         assert self.assertion_params['mean'] is not None, 'Must input or load reference mean'
@@ -252,7 +255,8 @@ def check_std(self, comparison_data=None):
 
         Returns
         -------
-        2 item tuple with test name and boolean expressing whether passed test.
+        (string, bool)
+            2 item tuple with test name and boolean expressing whether passed test.
 
         """
         assert self.assertion_params['std'] is not None, 'Must input or load reference std'
@@ -284,7 +288,8 @@ def check_ks(self, comparison_data=None):
 
         Returns
         -------
-        2 item tuple with test name and boolean expressing whether passed test.
+        (string, bool)
+            2 item tuple with test name and boolean expressing whether passed test.
 
         """
         assert self.assertion_params['ks_test'], 'Must input or load reference data ks-test'