More explicit differentiation between exception classes

Co-authored-by: Joseph H Kennedy <me@jhkennedy.org>
nsidc · Feb 11, 2025 · 6ce736a · 6ce736a
1 parent 1c5de64
commit 6ce736a
Showing 1 changed file with 10 additions and 1 deletion.
diff --git a/earthaccess/exceptions.py b/earthaccess/exceptions.py
@@ -13,6 +13,15 @@ class LoginStrategyUnavailable(Exception):
 
 
 class LoginAttemptFailure(Exception):
-    """The login attempt failed."""
+    """The login attempt failed.
+    
+    This should be raised when a login attempt fails, for example, because
+    the user's credentials were rejected.
+    
+    DO NOT raise this exception when a login strategy can't be attempted. For
+    example, this exception would not be thrown when "environment" was selected
+    but the envvars are not populated; a `LoginStrategyUnavailable` should be
+    thrown instead.
+    """
 
     pass