Skip to content

Commit

Permalink
update doc in Check
Browse files Browse the repository at this point in the history
  • Loading branch information
agoscinski committed Dec 21, 2023
1 parent da055dc commit 520988c
Showing 1 changed file with 7 additions and 8 deletions.
15 changes: 7 additions & 8 deletions src/scwidgets/check/_check.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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]

Expand Down

0 comments on commit 520988c

Please sign in to comment.