From f7e632025f643d2073f2e0280da6c6d908caf152 Mon Sep 17 00:00:00 2001 From: Mike Salvatore Date: Mon, 11 Jul 2022 09:27:19 -0400 Subject: [PATCH] Island: Reformat IEncryptor docstrings --- .../cc/server_utils/encryption/i_encryptor.py | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/monkey/monkey_island/cc/server_utils/encryption/i_encryptor.py b/monkey/monkey_island/cc/server_utils/encryption/i_encryptor.py index d83198b7b..d46e51c1a 100644 --- a/monkey/monkey_island/cc/server_utils/encryption/i_encryptor.py +++ b/monkey/monkey_island/cc/server_utils/encryption/i_encryptor.py @@ -5,16 +5,18 @@ from typing import Any class IEncryptor(ABC): @abstractmethod def encrypt(self, plaintext: Any) -> Any: - """Encrypts data and returns the ciphertext. + """ + Encrypts data and returns the ciphertext. + :param plaintext: Data that will be encrypted - :return: Ciphertext generated by encrypting value - :rtype: Any + :return: Ciphertext generated by encrypting the plaintext """ @abstractmethod def decrypt(self, ciphertext: Any): - """Decrypts data and returns the plaintext. - :param ciphertext: Ciphertext that will be decrypted - :return: Plaintext generated by decrypting value - :rtype: Any + """ + Decrypts data and returns the plaintext. + + :param ciphertext: Ciphertext that will be decrypted + :return: Plaintext generated by decrypting the ciphertext """