Island: Reformat IEncryptor docstrings

This commit is contained in:
Mike Salvatore 2022-07-11 09:27:19 -04:00
parent a733886365
commit f7e632025f
1 changed files with 9 additions and 7 deletions

View File

@ -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
"""