feat: docstring for the enroll function

cal-itp · Sep 10, 2024 · e4b4d7a · e4b4d7a
1 parent 7abf4e5
commit e4b4d7a
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/benefits/enrollment/enrollment.py b/benefits/enrollment/enrollment.py
@@ -24,6 +24,11 @@ class Status(Enum):
 
 
 def enroll(request, card_token):
+    """
+    Attempts to enroll this card into the transit processor group for the flow in the request's session.
+
+    Returns a tuple containing a Status indicating the result of the attempt and any exception that occurred.
+    """
     agency = session.agency(request)
     flow = session.flow(request)