Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify some comments / docstrings #592

Merged
merged 2 commits into from
Aug 27, 2024
Merged

Clarify some comments / docstrings #592

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
598c3dc
Clarify some comments / docstrings
mfisher87 Aug 23, 2024
65bf2d2
Merge branch 'development' into clarify-comments
mfisher87 Aug 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions icepyx/core/APIformatting.py
View file
Open in desktop
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