add example to generate_password

UBC-MDS · Jan 31, 2024 · f41a242 · f41a242
1 parent fc1d469
commit f41a242
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/src/passwordler/generate_password.py b/src/passwordler/generate_password.py
@@ -15,6 +15,12 @@ def generate_password(length=12, include_symbols=True, include_numbers=True):
 
     Returns:
     str: A randomly generated password.
+    
+    Example:
+    >>> generate_password()
+    Output: ',tKC]m"wDJ34'
+    >>> generate_password(include_symbols=False, include_numbers=False)
+    Output: 'NJfVKhgnrJYa'
     """
 
     if not isinstance(length, int):