From 38e61f5eb2a41af50996be8664d732911ea246a4 Mon Sep 17 00:00:00 2001
From: Dave Smith-Hayes <me@davesmithhayes.com>
Date: Mon, 18 Nov 2024 02:05:12 +0000
Subject: [PATCH] add some documentation to the test cases we are working on.

---
 app/tests/Domain/Repository/UserRepositoryTest.php | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/app/tests/Domain/Repository/UserRepositoryTest.php b/app/tests/Domain/Repository/UserRepositoryTest.php
index fbf55f3..b44d6d8 100644
--- a/app/tests/Domain/Repository/UserRepositoryTest.php
+++ b/app/tests/Domain/Repository/UserRepositoryTest.php
@@ -34,6 +34,10 @@ class UserRepositoryTest extends TestCase
 
         $results = $userRepository->create($user);
         $this->assertTrue($results);
+        /**
+         * We are testing if the User entity has been mutated by the `create`
+         * method in the UserRepository.
+         */
         $this->assertEquals(100, $user->getId());
     }
 }