Add some much-needed comments

uktrade · Oct 7, 2021 · 564b016 · 564b016
1 parent 73bc443
commit 564b016
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/api/licences/models.py b/api/licences/models.py
@@ -22,6 +22,9 @@ class HMRCIntegrationUsageData(TimestampableModel):
 
 
 class Licence(TimestampableModel):
+    """
+    A licence issued to an exporter application
+    """
     id = models.UUIDField(primary_key=True, default=uuid.uuid4, editable=False)
     reference_code = models.CharField(max_length=30, unique=True, editable=False)
     case = models.ForeignKey(Case, on_delete=models.CASCADE, null=False, blank=False, related_name="licences")
@@ -79,6 +82,7 @@ def save(self, *args, **kwargs):
         send_status_change_to_hmrc = kwargs.pop("send_status_change_to_hmrc", False)
         super(Licence, self).save(*args, **kwargs)
 
+        # Immediately notify HMRC if needed
         if LITE_HMRC_INTEGRATION_ENABLED and send_status_change_to_hmrc and self.status != LicenceStatus.DRAFT:
             self.send_to_hmrc_integration()