From a52bc378ab5817db38cd2b47b5ab0c5352128061 Mon Sep 17 00:00:00 2001 From: Matt Fisher Date: Tue, 27 Aug 2024 14:33:06 -0600 Subject: [PATCH] Clarify some comments / docstrings (#592) --- icepyx/core/APIformatting.py | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/icepyx/core/APIformatting.py b/icepyx/core/APIformatting.py index f30f9a11c..4b1966910 100644 --- a/icepyx/core/APIformatting.py +++ b/icepyx/core/APIformatting.py @@ -121,6 +121,9 @@ def combine_params(*param_dicts): """ Combine multiple dictionaries into one. + Merging is performed in sequence using `dict.update()`; dictionaries later in the + list overwrite those earlier. + Parameters ---------- params : dictionaries @@ -128,7 +131,7 @@ def combine_params(*param_dicts): Returns ------- - single dictionary of all input dictionaries combined + A single dictionary of all input dictionaries combined Examples -------- @@ -410,7 +413,10 @@ def build_params(self, **kwargs): for key in opt_keys: if key == "Coverage" and key in kwargs: - # DevGoal: make there be an option along the lines of Coverage=default, which will get the default variables for that product without the user having to input is2obj.build_wanted_wanted_var_list as their input value for using the Coverage kwarg + # DevGoal: make an option along the lines of Coverage=default, + # which will get the default variables for that product without + # the user having to input is2obj.build_wanted_wanted_var_list + # as their input value for using the Coverage kwarg self._fmted_keys.update( {key: _fmt_var_subset_list(kwargs[key])} )