Adds docstrings to models/classes.

canvas_sdk/v1/data/common.py

@@ -2,12 +2,16 @@
 
 
 class DocumentReviewMode(models.TextChoices):
+    """Choices for document reviews."""
+
     REVIEW_REQUIRED = "RR", "Review required"
     ALREADY_REVIEWED_OFFLINE = "AR", "Already reviewed offline"
     REVIEW_NOT_REQUIRED = "RN", "Review not required"
 
 
 class OrderStatus(models.TextChoices):
+    """Choices for Order statuses."""
+
     PROPOSED = "proposed", "Proposed"
     DRAFT = "draft", "Draft"
     PLANNED = "planned", "Planned"
@@ -25,6 +29,8 @@ class OrderStatus(models.TextChoices):
 
 
 class ReviewPatientCommunicationMethod(models.TextChoices):
+    """Choices for patient communication regarding reviews."""
+
     DELEGATED_CALL_CAN_LEAVE_MESSAGE = "DM", "delegate call, can leave message"
     DELEGATED_CALL_NEED_ANSWER = "DA", "delegate call, need patient to answer"
     DELEGATED_LETTER = "DL", "delegate letter"
@@ -34,5 +40,7 @@ class ReviewPatientCommunicationMethod(models.TextChoices):
 
 
 class ReviewStatus(models.TextChoices):
+    """Status choices for reviews."""
+
     STATUS_REVIEWING = "reviewing", "reviewing"
     STATUS_REVIEWED = "reviewed", "reviewed"

canvas_sdk/v1/data/imaging.py

@@ -11,6 +11,8 @@
 
 
 class ImagingOrder(models.Model):
+    """Model to read ImagingOrder data."""
+
     class Meta:
         managed = False
         app_label = "canvas_sdk"
@@ -41,6 +43,8 @@ class Meta:
 
 
 class ImagingReview(models.Model):
+    """Model to read ImagingReview data."""
+
     class Meta:
         managed = False
         app_label = "canvas_sdk"
@@ -67,6 +71,8 @@ class Meta:
 
 
 class ImagingReport(models.Model):
+    """Model to read ImagingReport data."""
+
     class ImagingReportSource(models.TextChoices):
         RADIOLOGY_FROM_PATIENT = "RADIOLOGY_PATIENT", "Radiology Report From Patient"
         VERBAL_FROM_PATIENT = "VERBAL_PATIENT", "Verbal Report From Patient"