Reword docstring of combine_metadata() to include time_parameters dict

pnuu · Feb 8, 2024 · 91dbc8e · 91dbc8e
1 parent 4e85a8f
commit 91dbc8e
Showing 1 changed file with 9 additions and 5 deletions.
diff --git a/satpy/dataset/metadata.py b/satpy/dataset/metadata.py
@@ -32,11 +32,15 @@ def combine_metadata(*metadata_objects):
 
     If the values corresponding to any keys are not equal or do not
     exist in all provided dictionaries then they are not included in
-    the returned dictionary.  The 'start_time' values will be set to the
-    earliest value and 'end_time' to latest time.  All other keys containing
-    the word 'time' are averaged.  Before these adjustments, non-datetime
-    objects are filtered out.  In the interest of time, lazy arrays are compared
-    by object identity rather than by their contents.
+    the returned dictionary.  All values of the keys containing the substring
+    'start_time' will be set to the earliest value and similarly for 'end_time'
+    to latest time.  All other keys containing the word 'time' are averaged.
+    Before these adjustments, non-datetime objects are filtered out.
+
+    The same rules are applied to 'time_parameters' dictionary.
+
+    In the interest of processing time, lazy arrays are compared by object
+    identity rather than by their contents.
 
     Args:
         *metadata_objects: MetadataObject or dict objects to combine