From: Stephen Burrows <stephen.r.burrows@gmail.com>
Date: Mon, 9 May 2011 20:53:12 +0000 (-0400)
Subject: Added Tag documentation.
X-Git-Tag: philo-0.9~12^2~23
X-Git-Url: http://git.ithinksw.org/philo.git/commitdiff_plain/ca4d8af448022675e9b2870a0e0149c8257037c4?hp=79e89d2c15b86b7b8d4ccf76c85d2fa2154cd2e8

Added Tag documentation.
---

diff --git a/docs/models/miscellaneous.rst b/docs/models/miscellaneous.rst
index 36fceb9..dfff87e 100644
--- a/docs/models/miscellaneous.rst
+++ b/docs/models/miscellaneous.rst
@@ -1,5 +1,10 @@
-Miscellaneous Support Classes
+Miscellaneous Support Models
 =============================
+.. currentmodule:: philo.models.nodes
 .. autoclass:: philo.models.nodes.TargetURLModel
 	:members:
-	:exclude-members: get_target_url
\ No newline at end of file
+	:exclude-members: get_target_url
+
+.. currentmodule:: philo.models.base
+.. autoclass:: philo.models.base.Tag
+	:members:
\ No newline at end of file
diff --git a/philo/models/base.py b/philo/models/base.py
index 573c339..436df42 100644
--- a/philo/models/base.py
+++ b/philo/models/base.py
@@ -18,10 +18,14 @@ from philo.validators import json_validator
 
 
 class Tag(models.Model):
+	"""A simple, generic model for tagging."""
+	#: A CharField (max length 255) which contains the name of the tag.
 	name = models.CharField(max_length=255)
+	#: A CharField (max length 255) which contains the tag's unique slug.
 	slug = models.SlugField(max_length=255, unique=True)
 	
 	def __unicode__(self):
+		"""Returns the value of the :attr:`name` field"""
 		return self.name
 	
 	class Meta: