From 967399d8b83c6bd4f1fccbb23a3745f8a0a0765f Mon Sep 17 00:00:00 2001 From: Alex Schofield Date: Sun, 2 Mar 2025 23:36:33 +0000 Subject: update docstring for obfuscate function --- gdpr_obfuscator/obfuscate.py | 13 +++++++++++-- 1 file 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: -- cgit v1.2.3