Clarify result testing in metadata operations decorator.

SciTools · Nov 15, 2023 · b00b37f · b00b37f
1 parent dca5dce
commit b00b37f
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/lib/iris/common/_split_attribute_dicts.py b/lib/iris/common/_split_attribute_dicts.py
@@ -105,7 +105,8 @@ def _inner_function(*args, **kwargs):
 
         result = operation(*args, **kwargs)
 
-        # Convert 'pairedkeys' dicts in the result back to split-attributes form.
+        # Convert known specific cases of 'pairedkeys' dicts in the result, and convert
+        # those back into split-attribute dictionaries.
         if isinstance(result, Mapping):
             # Fix a result which is a single dictionary -- for "combine"
             result = _convert_pairedkeys_dict_to_splitattrs(result)
@@ -117,6 +118,7 @@ def _inner_function(*args, **kwargs):
                 _convert_pairedkeys_dict_to_splitattrs(right),
             )
             result = result.__class__([left, right])
+        # ELSE: leave other types of result unchanged. E.G. None, bool
 
         return result