From f248bf9d7468d065c5452a207bf01646ec1e93eb Mon Sep 17 00:00:00 2001
From: Joe Wilson <joe.wilson@canvasmedical.com>
Date: Mon, 28 Oct 2024 14:06:21 -0700
Subject: [PATCH] Adds docstrings to models/classes.

---
 canvas_sdk/v1/data/common.py  | 8 ++++++++
 canvas_sdk/v1/data/imaging.py | 6 ++++++
 2 files changed, 14 insertions(+)

diff --git a/canvas_sdk/v1/data/common.py b/canvas_sdk/v1/data/common.py
index abc510e8..eb1b70d4 100644
--- a/canvas_sdk/v1/data/common.py
+++ b/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"
diff --git a/canvas_sdk/v1/data/imaging.py b/canvas_sdk/v1/data/imaging.py
index 6e1cd103..6502c7b4 100644
--- a/canvas_sdk/v1/data/imaging.py
+++ b/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"