From 31a15a666e69d96b5062596c79641645a64fcdb2 Mon Sep 17 00:00:00 2001
From: ankitjavalkar
Date: Wed, 16 Nov 2016 11:47:26 +0530
Subject: Modify docstrings of evaluators

---
 yaksh/bash_code_evaluator.py | 9 ++++++---
 1 file changed, 6 insertions(+), 3 deletions(-)

(limited to 'yaksh/bash_code_evaluator.py')

diff --git a/yaksh/bash_code_evaluator.py b/yaksh/bash_code_evaluator.py
index 7575725..b5974d2 100644
--- a/yaksh/bash_code_evaluator.py
+++ b/yaksh/bash_code_evaluator.py
@@ -40,14 +40,17 @@ class BashCodeEvaluator(CodeEvaluator):
 
         Returns
         --------
+        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") : If the student script passes all
+        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): If the student script fails a single
+        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): If mandatory arguments are not files or if
+        Returns (False, error_msg, 0.0): If mandatory arguments are not files or if
         the required permissions are not given to the file(s).
         """
         ref_code_path = test_case
-- 
cgit