From 520988cd76a066a733520d11af14dc1e044870f5 Mon Sep 17 00:00:00 2001 From: Alexander Goscinski Date: Thu, 14 Dec 2023 21:13:24 +0100 Subject: [PATCH] update doc in Check --- src/scwidgets/check/_check.py | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/src/scwidgets/check/_check.py b/src/scwidgets/check/_check.py index 8ca5b3a..68b9588 100644 --- a/src/scwidgets/check/_check.py +++ b/src/scwidgets/check/_check.py @@ -16,17 +16,16 @@ class Check: outputs. :param function_to_check: - The code_obj must have a `compute_output_to_check` function that accepts each - input parameters in :params input parameters: + The function must that accepts each input parameters in :params + input_parameters: :param inputs_parameters: A dict or a list of dictionaries each containing the argument name and its value as (key, value) pair that is used as input for the function - `compute_output_to_check` of - :param code_obj: + :param function_to_check: :param outputs_references: A list or a list of lists each containing the expected output of the function - `compute_output_to_check` of :param code_obj: for the inputsin the :param - input_parameters: + :param function_to_check: of :param function_to_check: for the inputs in the + :param input_parameters: :param asserts: A list of assert functions. An assert function can the output parameters of :param function_to_check: to run assert. If output references has been set it @@ -86,8 +85,8 @@ def __init__( f"arguments" ) - # We sadly cannot verify if the number of input argumets match because they can - # be hidden in **kwargs + # We cannot verify if the number of input argumets match because they can be + # hidden in **kwargs if isinstance(inputs_parameters, dict): inputs_parameters = [inputs_parameters]