forked from p15670423/monkey
Agent: Fix docstrings in IslandAPIClient
This commit is contained in:
parent
d53b3d5026
commit
b432a9f567
|
@ -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:
|
||||
|
|
Loading…
Reference in New Issue