Merge pull request #86 from UBC-MDS/add_function_examples

fix: Add function examples

src/passwordler/decrypt_password.py

@@ -23,10 +23,10 @@ def decrypt_password(encrypted_message, random_seed = 123):
     seed is utilized to maintain consistent decryption results when needed.
 
     Example:
-    >>> encrypted = encrypt_password('Monty Python', random_seed = 123)
-    >>> decrypted = decrypt_password(encrypted, random_seed = 123)
+    >>> original_message = 'Monty Python'
+    >>> encrypted_message = encrypt_password(original_message, random_seed = 123)
+    >>> decrypted_message = decrypt_password(encrypted_message, random_seed = 123)
     Output: 'Monty Python'
-
     """
     if not isinstance(encrypted_message, str):
         raise TypeError(

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):

src/passwordler/password_strength.py

@@ -14,6 +14,12 @@ def password_strength(password):
 
     Returns:
     str: a rating of either 'weak', 'good' or 'strong'
+    
+    Example:
+    >>> password_strength('baseball')
+    Output: 'Your password is: Weak'
+    >>> password_strength('Baseball4life!')
+    Output: 'Your password is: Strong'
     """
     if not isinstance(password, str):
         raise TypeError("'password' should be of type 'string'")