From ae0c440603bbc116bbec16692e5a9ab8723b2d95 Mon Sep 17 00:00:00 2001 From: Mike Salvatore Date: Fri, 17 Jun 2022 11:08:45 -0400 Subject: [PATCH] Island: Add documentation for IConfigRepository --- .../cc/repository/i_config_repository.py | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/monkey/monkey_island/cc/repository/i_config_repository.py b/monkey/monkey_island/cc/repository/i_config_repository.py index ce6935b87..def95e228 100644 --- a/monkey/monkey_island/cc/repository/i_config_repository.py +++ b/monkey/monkey_island/cc/repository/i_config_repository.py @@ -4,8 +4,21 @@ from common.configuration import AgentConfiguration class IConfigRepository(ABC): + """ + A repository used to store and retrieve the agent configuration. + """ def get_config(self) -> AgentConfiguration: + """ + Retrieve the agent configuration from the repository + + :return: The agent configuration + """ pass - def set_config(self, config: AgentConfiguration): + def set_config(self, agent_config: AgentConfiguration): + """ + Store the agent configuration in the repository + + :param agent_config: The agent configuration to store in the repository + """ pass