Docstring

jrbourbeau · Nov 16, 2023 · 46814f7 · 46814f7
1 parent f186096
commit 46814f7
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/earthaccess/api.py b/earthaccess/api.py
@@ -13,6 +13,13 @@
 
 
 def _normalize_location(location: Union[str, None]) -> Union[str, None]:
+    """Handle user-provided `daac` and `provider` values
+
+    These values must have a capital letter as the first character
+    followed by capital letters, numbers, or an underscore. Here we
+    uppercase all strings to handle the case when users provide
+    lowercase values (e.g. "pocloud" instead of "POCLOUD").
+    """
     if location is not None:
         location = location.upper()
     return location