From 70e464517d4692b61cea3c216dcee69e4cc436a6 Mon Sep 17 00:00:00 2001
From: Yannick DAYER <yannick.dayer@idiap.ch>
Date: Tue, 6 Dec 2022 12:05:01 +0100
Subject: [PATCH] [doc] Fix the confusing check_parameters docstring
---
src/bob/pipelines/utils.py | 2 +-
tests/test_utils.py | 9 +++++++++
2 files changed, 10 insertions(+), 1 deletion(-)
diff --git a/src/bob/pipelines/utils.py b/src/bob/pipelines/utils.py
index 97367d8..3275d5c 100644
--- a/src/bob/pipelines/utils.py
+++ b/src/bob/pipelines/utils.py
@@ -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).
diff --git a/tests/test_utils.py b/tests/test_utils.py
index 48ac1f7..488c796 100644
--- a/tests/test_utils.py
+++ b/tests/test_utils.py
@@ -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"
--
GitLab