fix: added and updated examples in functions

UBC-MDS · Jan 31, 2024 · da9cd77 · da9cd77
1 parent f41a242
commit da9cd77
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 1 deletion.
diff --git a/src/passwordler/decrypt_password.py b/src/passwordler/decrypt_password.py
@@ -27,7 +27,6 @@ def decrypt_password(encrypted_message, random_seed = 123):
     >>> 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(

diff --git a/src/passwordler/password_strength.py b/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'")