Changeset 12967 for trunk

Timestamp:

05/10/11 16:24:41 (13 years ago)

Author:

sil

Message:

added some comments

File:

• trunk/sara_cmt/sara_cmt/cluster/models.py (modified) (10 diffs)

trunk/sara_cmt/sara_cmt/cluster/models.py

@@ -27 +27 @@
 
 class Cluster(ModelExtension):
+    """
+        A labeled group of hardware pieces.
+    """
     name = models.CharField(max_length=255, unique=True)
 
@@ -32 +35 @@
         ordering = ('name',)
 
-    def __unicode__(self):
+    def __unicode__(self):nam
         return self.name or None
 
 
 class HardwareUnit(ModelExtension):
+    """
+        A specific piece of hardware.
+    """
     cluster      = models.ForeignKey('Cluster', related_name='hardware')
     role         = models.ManyToManyField('Role', related_name='hardware')
@@ -123 +129 @@
 
 class Interface(ModelExtension):
+    """
+        An interface of a piece of hardware.
+    """
     re_valid_mac = re.compile(r'([A-Fa-f\d]{2}[:-]?){5}[A-Fa-f\d]{2}')
     re_mac_octets = re.compile(r'[A-Fa-f\d]{2}')
@@ -334 +343 @@
     """
         A Rack is a standardized system for mounting various HardwareUnits in a
-        stack of slots. It is located on a site.
+        stack of slots.
     """
 
@@ -407 +416 @@
 
 class Room(ModelExtension):
+    """
+        A room is located at an address. This is where racks of hardware can be
+        found.
+    """
     address = models.ForeignKey(Address, related_name='rooms')
 
@@ -440 +453 @@
     addresses = models.ManyToManyField(Address, related_name='_companies')
 
-    #type    = models.ChoiceField() # !!! TODO: add choices like vendor / support / partner / etc... !!!
+    #type    = models.ChoiceField() # !!! TODO: add choices like vendor / support / partner / customer / etc... !!!
     name    = models.CharField(max_length=255)
     website = models.URLField()
@@ -481 +494 @@
 
 class Telephonenumber(ModelExtension):
+    """
+        Telephonenumber to link to a contact. Split in country-, area- and
+        subscriber-part for easy filtering.
+    """
     NUMBER_CHOICES = (
         ('T', 'Telephone'),
@@ -515 +532 @@
 class HardwareModel(ModelExtension):
     """
-        The Model-model is being used to specify some extra information about a
+        This model is being used to specify some extra information about a
         specific type (model) of hardware.
     """
@@ -552 +569 @@
 
 class InterfaceType(ModelExtension):
+    """
+        Contains information about different types of interfaces.
+    """
+    vendor = models.ForeignKey('Company', null=True, blank=True, related_name='interfaces')
+
     label = models.CharField(max_length=255, help_text="'DRAC 4' for example")
-    vendor = models.ForeignKey('Company', null=True, blank=True, related_name='interfaces')
 
     class Meta:
@@ -582 +603 @@
 class WarrantyType(ModelExtension):
     """
-A type of warranty offered by a company.
+        A type of warranty offered by a company.
     """
     contact = models.ForeignKey(Connection, related_name='warranty types')