Skip to content

Commit

Permalink
Improve combine_metadata documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
djhoese committed Oct 23, 2018
1 parent cbcefae commit d0a994e
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion satpy/dataset.py
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,8 @@ def timestamp_func(dt):
def combine_metadata(*metadata_objects, **kwargs):
"""Combine the metadata of two or more Datasets.
If any keys are not equal or do not exist in all provided dictionaries
then they are not included in the returned dictionary.
By default any keys with the word 'time' in them and consisting
of datetime objects will be averaged. This is to handle cases where
data were observed at almost the same time but not exactly.
Expand All @@ -87,7 +89,7 @@ def combine_metadata(*metadata_objects, **kwargs):
average_times (bool): Average any keys with 'time' in the name
Returns:
the combined metadata
dict: the combined metadata
"""
average_times = kwargs.get('average_times', True) # python 2 compatibility (no kwarg after *args)
Expand Down

0 comments on commit d0a994e

Please sign in to comment.