docs: docstring added to check_idl in input/utils

This commit is contained in:
Fabian Joswig 2022-01-16 16:56:53 +01:00
parent 5993f1a4ba
commit bb3a15d69b

View file

@ -2,11 +2,20 @@
def check_idl(idl, che):
"""Checks if list of configurations is contained in an idl
Parameters
----------
idl : range or list
idl of the current replicum
che : list
list of configurations to be checked against
"""
missing = []
for c in che:
if c not in idl:
missing.append(c)
# print missing such that it can directly be parsed to slurm terminal
# print missing configurations such that it can directly be parsed to slurm terminal
if not (len(missing) == 0):
print(len(missing), "configs missing")
miss_str = str(missing[0])