Added Tag documentation.
authorStephen Burrows <stephen.r.burrows@gmail.com>
Mon, 9 May 2011 20:53:12 +0000 (16:53 -0400)
committerStephen Burrows <stephen.r.burrows@gmail.com>
Mon, 9 May 2011 20:53:12 +0000 (16:53 -0400)
docs/models/miscellaneous.rst
philo/models/base.py

index 36fceb9..dfff87e 100644 (file)
@@ -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
index 573c339..436df42 100644 (file)
@@ -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: