From 736148f21dd133359be1e593fe8230bcc47dd15f Mon Sep 17 00:00:00 2001
From: Calen Pennington <calen.pennington@gmail.com>
Date: Mon, 2 Jul 2012 09:02:41 -0400
Subject: [PATCH] Adding clarifying comment about the contents of 'data'
---
common/lib/xmodule/x_module.py | 5 ++++-
1 file changed, 4 insertions(+), 1 deletion(-)
diff --git a/common/lib/xmodule/x_module.py b/common/lib/xmodule/x_module.py
index f791e7f3074..0b8fbb54d47 100644
--- a/common/lib/xmodule/x_module.py
+++ b/common/lib/xmodule/x_module.py
@@ -75,7 +75,10 @@ class XModule(object):
system: An I4xSystem allowing access to external resources
location: Something Location-like that identifies this xmodule
definition: A dictionary containing 'data' and 'children'. Both are optional
- 'data': is JSON-like (string, dictionary, list, bool, or None, optionally nested)
+ 'data': is JSON-like (string, dictionary, list, bool, or None, optionally nested).
+ This defines all of the data necessary for a problem to display that is intrinsic to the problem.
+ It should not include any data that would vary between two courses using the same problem
+ (due dates, grading policy, randomization, etc.)
'children': is a list of Location-like values for child modules that this module depends on
instance_state: A string of serialized json that contains the state of this module for
current student accessing the system, or None if no state has been saved
--
GitLab