From: tjhunt <tjhunt>
Date: Wed, 23 Aug 2006 21:04:04 +0000 (+0000)
Subject: Clarified comment.
X-Git-Url: http://git.mjollnir.org/gw?a=commitdiff_plain;h=ac249da55ee2665d9bc26cfbc6a7eee19b92fabf;p=moodle.git

Clarified comment.
---

diff --git a/question/type/questiontype.php b/question/type/questiontype.php
index e02f0c1de1..858d5901e2 100644
--- a/question/type/questiontype.php
+++ b/question/type/questiontype.php
@@ -829,10 +829,12 @@ class default_questiontype {
     *                          compared. Question type specific information is
     *                          included.
     * @param object $state     The state of the question. The responses are in
-    *                          ->responses.
+    *                          ->responses. This is the only field of $state
+    *                          that it is safe to use.
     * @param object $teststate The state whose responses are to be
     *                          compared. The state will be of the same age or
-    *                          older than $state.
+    *                          older than $state. Again, the method should only
+    *                          use the field $teststate->responses.
     */
     function compare_responses(&$question, $state, $teststate) {
         // The default implementation performs a comparison of the response