Skip to content

Commit

Permalink
Clarify some comments / docstrings (#592)
Browse files Browse the repository at this point in the history
  • Loading branch information
mfisher87 authored Aug 27, 2024
1 parent 50f9351 commit a52bc37
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions icepyx/core/APIformatting.py
Original file line number Diff line number Diff line change
Expand Up @@ -121,14 +121,17 @@ 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
Unlimited number of dictionaries to combine
Returns
-------
single dictionary of all input dictionaries combined
A single dictionary of all input dictionaries combined
Examples
--------
Expand Down Expand Up @@ -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])}
)
Expand Down

0 comments on commit a52bc37

Please sign in to comment.