From bc40ea0a9e378152ec887e3050a5a6780ca8c094 Mon Sep 17 00:00:00 2001
From: David Mudrak <david.mudrak@gmail.com>
Date: Mon, 4 Jan 2010 17:56:23 +0000
Subject: [PATCH] Better explanation of the returned value

---
 mod/workshop/assessment.php                    | 3 ++-
 mod/workshop/grading/accumulative/strategy.php | 6 +++---
 mod/workshop/grading/lib.php                   | 2 +-
 3 files changed, 6 insertions(+), 5 deletions(-)

diff --git a/mod/workshop/assessment.php b/mod/workshop/assessment.php
index cc7072b3fe..6eee1f5c75 100644
--- a/mod/workshop/assessment.php
+++ b/mod/workshop/assessment.php
@@ -114,7 +114,8 @@ if ($mform->is_cancelled()) {
         echo $OUTPUT->footer();
         die();  // bye-bye
     } else {
-        // save and continue - redirect to self to prevent data being re-posted by pressing "Reload"
+        // either it is not possible to calculate the $rawgrade or the reviewer has chosen "Save and continue"
+        // redirect to self to prevent data being re-posted by pressing "Reload"
         redirect($PAGE->url);
     }
 }
diff --git a/mod/workshop/grading/accumulative/strategy.php b/mod/workshop/grading/accumulative/strategy.php
index dd342ccae2..027db51ba7 100644
--- a/mod/workshop/grading/accumulative/strategy.php
+++ b/mod/workshop/grading/accumulative/strategy.php
@@ -199,7 +199,7 @@ class workshop_accumulative_strategy implements workshop_strategy {
      *
      * @param stdClass $assessment Assessment being filled
      * @param stdClass $data       Raw data as returned by the assessment form
-     * @return float|null        Percentual grade for submission as suggested by the peer
+     * @return float|null          Raw grade (0 to 1) for submission as suggested by the peer
      */
     public function save_assessment(stdClass $assessment, stdClass $data) {
         global $DB;
@@ -363,7 +363,7 @@ class workshop_accumulative_strategy implements workshop_strategy {
      * Aggregates the assessment form data and sets the grade for the submission given by the peer
      *
      * @param stdClass $assessment Assessment record
-     * @return float|null          Percentual grade for submission as suggested by the peer
+     * @return float|null          Raw grade (from 0 to 1) for submission as suggested by the peer
      */
     protected function update_peer_grade(stdClass $assessment) {
         $grades     = $this->get_current_assessment_data($assessment);
@@ -379,7 +379,7 @@ class workshop_accumulative_strategy implements workshop_strategy {
      *
      * @param array $grades Grade records as returned by {@link get_current_assessment_data}
      * @uses $this->dimensions
-     * @return float|null   Percentual grade for submission as suggested by the peer
+     * @return float|null   Raw grade (from 0 to 1) for submission as suggested by the peer
      */
     protected function calculate_peer_grade(array $grades) {
 
diff --git a/mod/workshop/grading/lib.php b/mod/workshop/grading/lib.php
index 13f0ee9536..0beafa65d0 100644
--- a/mod/workshop/grading/lib.php
+++ b/mod/workshop/grading/lib.php
@@ -68,7 +68,7 @@ interface workshop_strategy {
      *
      * @param stdClass $assessment Assessment being filled
      * @param stdClass $data       Raw data as returned by the assessment form
-     * @return float|null          Percentual grade for submission as suggested by the peer or null if impossible to count
+     * @return float|null          Raw grade (0 to 1) for submission as suggested by the peer or null if impossible to count
      */
     public function save_assessment(stdClass $assessment, stdClass $data);
 }
-- 
2.39.5