From d2906ef23bf384207c9ecc83411d4643a73658d7 Mon Sep 17 00:00:00 2001 From: Mike Salvatore Date: Fri, 1 Jul 2022 10:00:56 -0400 Subject: [PATCH] Island: Add docstrings to {get,save}_simulation() --- .../cc/repository/i_simulation_repository.py | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/monkey/monkey_island/cc/repository/i_simulation_repository.py b/monkey/monkey_island/cc/repository/i_simulation_repository.py index b13c46240..880d456fd 100644 --- a/monkey/monkey_island/cc/repository/i_simulation_repository.py +++ b/monkey/monkey_island/cc/repository/i_simulation_repository.py @@ -7,10 +7,22 @@ from monkey_island.cc.services.mode.mode_enum import IslandModeEnum class ISimulationRepository(ABC): @abstractmethod def save_simulation(self, simulation: Simulation): + """ + Save the simulation state + + :param simulation: The simulation state + :raises StorageError: If the simulation states could not be saved + """ pass @abstractmethod def get_simulation(self) -> Simulation: + """ + Get the simulation state + + :raises RetrievalError: If the simulation state could not be retrieved + """ + pass @abstractmethod