From a87db2b070eb3af9791ca1e837dd1ad6be3249ed Mon Sep 17 00:00:00 2001
From: s0llvan <178677095+s0llvan@users.noreply.github.com>
Date: Tue, 24 Sep 2024 20:10:05 +0000
Subject: [PATCH] Add comments to test_get_pages_count

---
 src/paperless_tesseract/tests/test_parser.py | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/src/paperless_tesseract/tests/test_parser.py b/src/paperless_tesseract/tests/test_parser.py
index b54c1ecd7..c4e475f01 100644
--- a/src/paperless_tesseract/tests/test_parser.py
+++ b/src/paperless_tesseract/tests/test_parser.py
@@ -58,6 +58,14 @@ class TestParser(DirectoriesMixin, FileSystemAssertsMixin, TestCase):
         self.assertContainsStrings(text.strip(), ["This is a test document."])
 
     def test_get_pages_count(self):
+        """
+        GIVEN:
+            - PDF file with a single page
+        WHEN:
+            - The number of pages is requested
+        THEN:
+            - The method returns 1 as the expected number of pages
+        """
         parser = RasterisedDocumentParser(uuid.uuid4())
         pages_count = parser.get_pages_count(
             os.path.join(self.SAMPLE_FILES, "simple-digital.pdf"),
@@ -65,6 +73,14 @@ class TestParser(DirectoriesMixin, FileSystemAssertsMixin, TestCase):
         )
         self.assertEqual(pages_count, 1)
 
+        """
+        GIVEN:
+            - PDF file with multiple pages
+        WHEN:
+            - The number of pages is requested
+        THEN:
+            - The method returns the correct number of pages (6)
+        """
         pages_count = parser.get_pages_count(
             os.path.join(self.SAMPLE_FILES, "multi-page-mixed.pdf"),
             "application/pdf",