From 812df3782a7f5aacd2391ccdf553abd53c688d8c Mon Sep 17 00:00:00 2001
From: Trenton Holmes <797416+stumpylog@users.noreply.github.com>
Date: Sat, 19 Nov 2022 17:47:18 -0800
Subject: [PATCH] Documents the test conditions

---
 src/documents/tests/test_api.py | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)

diff --git a/src/documents/tests/test_api.py b/src/documents/tests/test_api.py
index a7e2be53f..c9d8aefc2 100644
--- a/src/documents/tests/test_api.py
+++ b/src/documents/tests/test_api.py
@@ -2491,6 +2491,15 @@ class TestBulkDownload(DirectoriesMixin, APITestCase):
 
     @override_settings(FILENAME_FORMAT="{correspondent}/{title}")
     def test_formatted_download_originals(self):
+        """
+        GIVEN:
+            - Defined file naming format
+        WHEN:
+            - Bulk download request for original documents
+            - Bulk download request requests to follow format
+        THEN:
+            - Files defined in resulting zipfile are formatted
+        """
 
         c = Correspondent.objects.create(name="test")
         c2 = Correspondent.objects.create(name="a space name")
@@ -2534,6 +2543,15 @@ class TestBulkDownload(DirectoriesMixin, APITestCase):
 
     @override_settings(FILENAME_FORMAT="somewhere/{title}")
     def test_formatted_download_archive(self):
+        """
+        GIVEN:
+            - Defined file naming format
+        WHEN:
+            - Bulk download request for archive documents
+            - Bulk download request requests to follow format
+        THEN:
+            - Files defined in resulting zipfile are formatted
+        """
 
         self.doc2.title = "This is Doc 2"
         self.doc2.save()
@@ -2570,6 +2588,15 @@ class TestBulkDownload(DirectoriesMixin, APITestCase):
 
     @override_settings(FILENAME_FORMAT="{document_type}/{title}")
     def test_formatted_download_both(self):
+        """
+        GIVEN:
+            - Defined file naming format
+        WHEN:
+            - Bulk download request for original documents and archive documents
+            - Bulk download request requests to follow format
+        THEN:
+            - Files defined in resulting zipfile are formatted
+        """
 
         dc1 = DocumentType.objects.create(name="bill")
         dc2 = DocumentType.objects.create(name="statement")