add comments for description of obfuscator.py tests

1 files changed, 6 insertions, 4 deletions

diff --git a/test/test_obfuscator.py b/test/test_obfuscator.py
index c77b6b4..0245a26 100644
--- a/test/test_obfuscator.py
+++ b/test/test_obfuscator.py
@@ -1,6 +1,7 @@
 from obfuscator.obfuscate import obfuscate
 
-
+# Check if the function can obfuscate valid PII fields in a list
+# of dictionaries
 def test_obfuscate_data_with_valid_pii_fields():
     data = [
         {
@@ -35,7 +36,8 @@ def test_obfuscate_data_with_valid_pii_fields():
     result = obfuscate(data, pii_fields)
     assert result == expected
 
-
+# Check if the function can obfuscate data even when some PII
+# fields are missing from some of the data
 def test_obfuscate_data_with_missing_pii_field():
     data = [
         {"student_id": "1234", "name": "John Smith", "course": "Software"},
@@ -60,7 +62,7 @@ def test_obfuscate_data_with_missing_pii_field():
     result = obfuscate(data, pii_fields)
     assert result == expected
 
-
+# Check if the function can handle an empty list of data
 def test_obfuscate_data_with_no_data():
     data = []
     pii_fields = ["name", "email_address"]
@@ -69,7 +71,7 @@ def test_obfuscate_data_with_no_data():
     result = obfuscate(data, pii_fields)
     assert result == expected
 
-
+# Check if the function can handle an empty list of PII fields
 def test_obfuscate_data_with_empty_pii_fields():
     data = [
         {