Document value store methods
authorSverre Rabbelier <srabbelier@gmail.com>
Sat, 12 Sep 2009 21:25:56 +0200
changeset 2908 391d57b91615
parent 2907 fbf0d63f37b9
child 2909 81eaf0a9101f
Document value store methods
app/soc/modules/core.py
--- a/app/soc/modules/core.py	Sat Sep 12 17:10:39 2009 +0200
+++ b/app/soc/modules/core.py	Sat Sep 12 21:25:56 2009 +0200
@@ -141,6 +141,9 @@
 
   def startNewRequest(self, request):
     """Prepares core to handle a new request.
+
+    Args:
+      request: a Django HttpRequest object
     """
 
     self.in_request = True
@@ -149,6 +152,9 @@
 
   def endRequest(self, request):
     """Performs cleanup after current request.
+
+    Args:
+      request: a Django HttpRequest object
     """
 
     old_request = self.getRequestValue('request')
@@ -161,6 +167,10 @@
 
   def getRequestValue(self, key, default=None):
     """Gets a per-request value.
+
+    Args:
+      key: the key of the to be retrieved value
+      default: the default value (returned if no value is set)
     """
 
     assert self.in_request
@@ -168,6 +178,10 @@
 
   def setRequestValue(self, key, value):
     """Sets a per-request value.
+
+    Args:
+      key: the key of the to be set value
+      value: the value that should be set
     """
 
     assert self.in_request