Agent: Fix docstrings in IslandAPIClient

This commit is contained in:
Shreya Malviya 2022-09-19 17:16:10 +05:30
parent d53b3d5026
commit b432a9f567
1 changed files with 7 additions and 4 deletions

View File

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