Merge pull request #3 from ajschofield/add-docs

update README & add comments in src code

1 files changed, 8 insertions, 4 deletions

diff --git a/test/test_obfuscator.py b/test/test_obfuscator.py
index c77b6b4..cc7d2c1 100644
--- a/test/test_obfuscator.py
+++ b/test/test_obfuscator.py
@@ -1,6 +1,7 @@
 from obfuscator.obfuscate import obfuscate
 
-
+# Check if the function does what its supposed to and can obfuscate 
+# valid PII fields in a list of dictionaries
 def test_obfuscate_data_with_valid_pii_fields():
     data = [
         {
@@ -35,7 +36,9 @@ 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, returning a list of dictionaries
+# but with the missing PII fields obfuscated and the rest of the data intact
 def test_obfuscate_data_with_missing_pii_field():
     data = [
         {"student_id": "1234", "name": "John Smith", "course": "Software"},
@@ -60,7 +63,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, returning an empty list
 def test_obfuscate_data_with_no_data():
     data = []
     pii_fields = ["name", "email_address"]
@@ -69,7 +72,8 @@ 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, returning the data as is
+# without mutating it
 def test_obfuscate_data_with_empty_pii_fields():
     data = [
         {