From b432a9f56795587e66a326db9666484be5d4c7bf Mon Sep 17 00:00:00 2001 From: Shreya Malviya Date: Mon, 19 Sep 2022 17:16:10 +0530 Subject: [PATCH] Agent: Fix docstrings in IslandAPIClient --- .../infection_monkey/transport/island_api_client.py | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/monkey/infection_monkey/transport/island_api_client.py b/monkey/infection_monkey/transport/island_api_client.py index f872de295..1ec193230 100644 --- a/monkey/infection_monkey/transport/island_api_client.py +++ b/monkey/infection_monkey/transport/island_api_client.py @@ -14,15 +14,18 @@ logger = logging.getLogger(__name__) class IslandAPIClient: """ - Represents Island API client + A client for requests from the Agent to the Island API """ def __init__(self, island_server: str): """ - Tries to connect to the island. + Verifies connection to the Island by raising an error if it can't connect - :param island_server: String representing the island ip address and port - :raises IslandAPIError: + :param island_server: Address to the Island + :raises IslandAPIConnectionError: If a connection cannot be made with the Island + :raises IslandAPITimeoutError: If a timeout occurs before being able to connect + with the Island + :raises IslandAPIError: If an unexpected error occurs with the Island API """ try: