Skip to content
Snippets Groups Projects
Commit 70e46451 authored by Yannick DAYER's avatar Yannick DAYER
Browse files

[doc] Fix the confusing check_parameters docstring

parent 360d4c13
Branches
Tags
1 merge request!105[utils.py] changed return type in check_parameters_for_validity to ensure that a list is returned
Pipeline #67549 passed
......@@ -86,7 +86,7 @@ def check_parameters_for_validity(
"""Checks the given parameters for validity.
Checks a given parameter is in the set of valid parameters. It also
assures that the parameters form a tuple or a list. If parameters is
assures that the returned parameters form a list. If parameters is
'None' or empty, the default_parameters will be returned (if
default_parameters is omitted, all valid_parameters are returned).
......
......@@ -235,6 +235,15 @@ def test_check_parameters_validity():
== f"Invalid {desc_str} '{param[1]}'. Valid values are {valid_values}, or lists/tuples of those"
)
# Empty default parameter
param = None
default = None
retval = check_parameters_for_validity(
param, desc_str, valid_values, default
)
assert type(retval) is list
assert retval == valid_values
# Invalid default parameter
param = None
default = "false"
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment