improved documentations on classes #41

fbormann
1 parent 3ea9a771
Showing 1 changed file with 14 additions and 0 deletions Show diff stats
core/models.py
@@ -24,6 +24,10 @@ class Resource(models.Model):
     """
 		It represents the resource where the action was applied on.
 		Example: Pool was answered (Resource: Pool), PDF was visualized(Resource: PDF).
+
+        Attributes:
+            @name: name of the resource affected
+            @created_date: The date the resource was created
     """
  
     name = models.CharField(_('Name'), max_length =100)
@@ -51,6 +55,16 @@ class Action_Resource(models.Model):
  
  
 class Notification(models.Model):
+    """
+    Attributes:
+        @message: The message that will be shown on the notification prompt
+        @user: The User that the notification will be sent to.
+        @read: Whether or not the user has read the notification.
+        @datetime: The time the notification was created
+        @action_resource: The Object that holds the information about which action was perfomed on the Resource
+        @actor: The user who applied the action
+    """
+
     message = models.TextField(_('Message'))
     user = models.ForeignKey(User, related_name = _('%(class)s_Actor'), verbose_name= _('User'))
     read = models.BooleanField(_('Read'), default = False)
...	...	@@ -24,6 +24,10 @@ class Resource(models.Model):
24	24	"""
25	25	It represents the resource where the action was applied on.
26	26	Example: Pool was answered (Resource: Pool), PDF was visualized(Resource: PDF).
	27	+
	28	+ Attributes:
	29	+ @name: name of the resource affected
	30	+ @created_date: The date the resource was created
27	31	"""
28	32
29	33	name = models.CharField(_('Name'), max_length =100)
...	...	@@ -51,6 +55,16 @@ class Action_Resource(models.Model):
51	55
52	56
53	57	class Notification(models.Model):
	58	+ """
	59	+ Attributes:
	60	+ @message: The message that will be shown on the notification prompt
	61	+ @user: The User that the notification will be sent to.
	62	+ @read: Whether or not the user has read the notification.
	63	+ @datetime: The time the notification was created
	64	+ @action_resource: The Object that holds the information about which action was perfomed on the Resource
	65	+ @actor: The user who applied the action
	66	+ """
	67	+
54	68	message = models.TextField(_('Message'))
55	69	user = models.ForeignKey(User, related_name = _('%(class)s_Actor'), verbose_name= _('User'))
56	70	read = models.BooleanField(_('Read'), default = False)
...	...