Agent: Reword get_agent_signals docstring

This commit is contained in:
Ilija Lazoroski 2022-09-23 15:55:12 +02:00 committed by Mike Salvatore
parent d1fc4fa7f4
commit a314efb8d9
1 changed files with 3 additions and 2 deletions

View File

@ -135,11 +135,12 @@ class IIslandAPIClient(ABC):
@abstractmethod
def get_agent_signals(self, agent_id: str) -> Optional[datetime]:
"""
Get agent signals from the island
Gets an agent's signals from the island
:param agent_id: ID of the agent whose signals should be retrieved
:raises IslandAPIConnectionError: If the client could not connect to the island
:raises IslandAPIRequestError: If there was a problem with the client request
:raises IslandAPIRequestFailedError: If the server experienced an error
:raises IslandAPITimeoutError: If the command timed out
:return: Terminate datetime
:return: The relevant agent's terminate signal's timestamp
"""