From 6d92ce9fdb9adb7b569aae49a087defd274045c1 Mon Sep 17 00:00:00 2001 From: PatchOfScotland Date: Sat, 11 Feb 2023 23:51:23 +0100 Subject: [PATCH] added comment to parameter sweep function --- functionality/meow.py | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/functionality/meow.py b/functionality/meow.py index 1ee726b..f0e0ad8 100644 --- a/functionality/meow.py +++ b/functionality/meow.py @@ -64,6 +64,10 @@ def replace_keywords(old_dict:Dict[str,str], job_id:str, src_path:str, def create_parameter_sweep(variable_name:str, start:Union[int,float,complex], stop:Union[int,float,complex], jump:Union[int,float,complex] )->Dict[str,Dict[str,Union[int,float,complex]]]: + """Function to create a valid parameter sweep dict for a givan variable, + from start to stop, with a regular jump of jump. This function will perform + some basic checks to ensure this isn't infinitie in nature as that + would lead to unlimited jobs scheduled per event.""" check_type(variable_name, str, hint="create_parameter_sweep.variable_name") check_type(start, int, alt_types=[float, complex]) check_type(stop, int, alt_types=[float, complex])