Modify docstrings of evaluators

1 files changed, 20 insertions, 0 deletions

diff --git a/yaksh/python_assertion_evaluator.py b/yaksh/python_assertion_evaluator.py
index 8924643..1cc4fa4 100644
--- a/yaksh/python_assertion_evaluator.py
+++ b/yaksh/python_assertion_evaluator.py
@@ -37,6 +37,26 @@ class PythonAssertionEvaluator(CodeEvaluator):
             return self.exec_scope
 
     def check_code(self, user_answer, file_paths, partial_grading, test_case, weight):
+        """ Function validates user answer by running an assertion based test case
+        against it
+
+        Returns
+        --------
+        Returns a tuple (success, error, test_case_weight)
+
+        success - Boolean, indicating if code was executed successfully, correctly
+        weight - Float, indicating total weight of all successful test cases
+        error - String, error message if success is false
+
+        returns (True, "Correct answer", 1.0) : If the student script passes all
+        test cases/have same output, when compared to the instructor script
+
+        returns (False, error_msg, 0.0): If the student script fails a single
+        test/have dissimilar output, when compared to the instructor script.
+
+        Returns (False, error_msg, 0.0): If mandatory arguments are not files or if
+        the required permissions are not given to the file(s).
+        """
         success = False
         test_case_weight = 0.0
         try: