X-Git-Url: http://git.ithinksw.org/philo.git/blobdiff_plain/54d1617957cfa3a8c9ffd714ad6c4bef09e727de..ca4d8af448022675e9b2870a0e0149c8257037c4:/philo/models/base.py

diff --git a/philo/models/base.py b/philo/models/base.py
index 466b60a..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:
@@ -40,7 +44,7 @@ class Titled(models.Model):
 		abstract = True
 
 
-#: An instance of :class:`ContentTypeRegistryLimiter` which is used to track the content types which can be related to by ForeignKeyValues and ManyToManyValues.
+#: An instance of :class:`ContentTypeRegistryLimiter` which is used to track the content types which can be related to by :class:`ForeignKeyValue`\ s and :class:`ManyToManyValue`\ s.
 value_content_type_limiter = ContentTypeRegistryLimiter()
 
 
@@ -340,7 +344,7 @@ class TreeManager(models.Manager):
 	
 	def get_with_path(self, path, root=None, absolute_result=True, pathsep='/', field='slug'):
 		"""
-		If ``absolute_result`` is ``True``, returns the object at ``path`` (starting at ``root``) or raises a :exception:`DoesNotExist` exception. Otherwise, returns a tuple containing the deepest object found along ``path`` (or ``root`` if no deeper object is found) and the remainder of the path after that object as a string (or None if there is no remaining path).
+		If ``absolute_result`` is ``True``, returns the object at ``path`` (starting at ``root``) or raises a :class:`DoesNotExist` exception. Otherwise, returns a tuple containing the deepest object found along ``path`` (or ``root`` if no deeper object is found) and the remainder of the path after that object as a string (or None if there is no remaining path).
 		
 		.. note:: If you are looking for something with an exact path, it is faster to use absolute_result=True, unless the path depth is over ~40, in which case the high cost of the absolute query may make a binary search (i.e. non-absolute) faster.