update docstring for obfuscate function

1 files changed, 11 insertions, 2 deletions

diff --git a/gdpr_obfuscator/obfuscate.py b/gdpr_obfuscator/obfuscate.py
index 722b750..63c0da8 100644
--- a/gdpr_obfuscator/obfuscate.py
+++ b/gdpr_obfuscator/obfuscate.py
@@ -5,8 +5,17 @@ def obfuscate_data(
     data: List[Dict[str, str]], pii_fields: List[str]
 ) -> List[Dict[str, str]]:
     """
-    A function to obfuscate PII fields in a list of dictionaries, replacing
-    sensitive values with a string of asterisks.
+
+
+    Args:
+        data (List[Dict[str, str]]): _description_
+        pii_fields (List[str]): _description_
+
+    Raises:
+        ValueError: _description_
+
+    Returns:
+        List[Dict[str, str]]: _description_
     """
 
     for record in data: