docstring improvements

- Added Attribute docstring to all model objects

InvenTree/stock/models.py

@@ -77,10 +77,23 @@ def before_delete_stock_location(sender, instance, using, **kwargs):
 
 class StockItem(models.Model):
     """
-    A 'StockItem' instance represents a quantity of physical instances of a part.
-    It may exist in a StockLocation, or as part of a sub-assembly installed into another StockItem
-    StockItems may be tracked using batch or serial numbers.
-    If a serial number is assigned, then StockItem cannot have a quantity other than 1
+    A StockItem object represents a quantity of physical instances of a part.
+    
+    Attributes:
+        part: Link to the master abstract part that this StockItem is an instance of
+        supplier_part: Link to a specific SupplierPart (optional)
+        location: Where this StockItem is located
+        quantity: Number of stocked units
+        batch: Batch number for this StockItem
+        URL: Optional URL to link to external resource
+        updated: Date that this stock item was last updated (auto)
+        stocktake_date: Date of last stocktake for this item
+        stocktake_user: User that performed the most recent stocktake
+        review_needed: Flag if StockItem needs review
+        delete_on_deplete: If True, StockItem will be deleted when the stock level gets to zero
+        status: Status of this StockItem (ref: ITEM_STATUS_CODES)
+        notes: Extra notes field
+        infinite: If True this StockItem can never be exhausted
     """
 
     def save(self, *args, **kwargs):
@@ -171,46 +184,33 @@ class StockItem(models.Model):
             }
         )
 
-    # The 'master' copy of the part of which this stock item is an instance
     part = models.ForeignKey('part.Part', on_delete=models.CASCADE, related_name='locations', help_text='Base part')
 
-    # The 'supplier part' used in this instance. May be null if no supplier parts are defined the master part
     supplier_part = models.ForeignKey('part.SupplierPart', blank=True, null=True, on_delete=models.SET_NULL,
                                       help_text='Select a matching supplier part for this stock item')
 
-    # Where the part is stored. If the part has been used to build another stock item, the location may not make sense
     location = models.ForeignKey(StockLocation, on_delete=models.DO_NOTHING,
                                  related_name='stock_items', blank=True, null=True,
                                  help_text='Where is this stock item located?')
 
-    # If this StockItem belongs to another StockItem (e.g. as part of a sub-assembly)
     belongs_to = models.ForeignKey('self', on_delete=models.DO_NOTHING,
                                    related_name='owned_parts', blank=True, null=True,
                                    help_text='Is this item installed in another item?')
 
-    # The StockItem may be assigned to a particular customer
     customer = models.ForeignKey('company.Company', on_delete=models.SET_NULL,
                                  related_name='stockitems', blank=True, null=True,
                                  help_text='Item assigned to customer?')
 
-    # Optional serial number
     serial = models.PositiveIntegerField(blank=True, null=True,
                                          help_text='Serial number for this item')
-
-    # Optional URL to link to external resource
+ 
     URL = models.URLField(max_length=125, blank=True)
 
-    # Optional batch information
     batch = models.CharField(max_length=100, blank=True, null=True,
                              help_text='Batch code for this stock item')
 
-    # If this part was produced by a build, point to that build here
-    # build = models.ForeignKey('build.Build', on_delete=models.SET_NULL, blank=True, null=True)
-
-    # Quantity of this stock item. Value may be overridden by other settings
     quantity = models.PositiveIntegerField(validators=[MinValueValidator(0)], default=1)
 
-    # Last time this item was updated (set automagically)
     updated = models.DateField(auto_now=True)
 
     # last time the stock was checked / counted
@@ -409,33 +409,34 @@ class StockItem(models.Model):
 
 
 class StockItemTracking(models.Model):
-    """ Stock tracking entry
+    """ Stock tracking entry - breacrumb for keeping track of automated stock transactions
+
+    Attributes:
+        item: Link to StockItem
+        date: Date that this tracking info was created
+        title: Title of this tracking info (generated by system)
+        notes: Associated notes (input by user)
+        user: The user associated with this tracking info
+        quantity: The StockItem quantity at this point in time
     """
 
     def get_absolute_url(self):
         return '/stock/track/{pk}'.format(pk=self.id)
         # return reverse('stock-tracking-detail', kwargs={'pk': self.id})
 
-    # Stock item
     item = models.ForeignKey(StockItem, on_delete=models.CASCADE,
                              related_name='tracking_info')
 
-    # Date this entry was created (cannot be edited)
     date = models.DateTimeField(auto_now_add=True, editable=False)
 
-    # Short-form title for this tracking entry
     title = models.CharField(blank=False, max_length=250)
 
-    # Optional longer description
     notes = models.TextField(blank=True)
 
-    # Which user created this tracking entry?
     user = models.ForeignKey(User, on_delete=models.SET_NULL, blank=True, null=True)
 
-    # Was this tracking note auto-generated by the system?
     system = models.BooleanField(default=False)
 
-    # Keep track of the StockItem quantity throughout the tracking history
     quantity = models.PositiveIntegerField(validators=[MinValueValidator(0)], default=1)
 
     # TODO