refactor: docstrings

commerce_coordinator/apps/commercetools/clients.py

@@ -608,7 +608,7 @@ def is_first_time_discount_eligible(self, email: str) -> bool:
         """
         Check if a user is eligible for a first time discount
         Args:
-            username (str): Username of the user
+            email (str): Email of the user
         Returns (bool): True if the user is eligible for a first time discount
         """
         try:

commerce_coordinator/apps/commercetools/pipeline.py

@@ -419,10 +419,10 @@ def run_filter(self, email):  # pylint: disable=arguments-differ
         """
         Execute a filter with the signature specified.
         Arguments:
-            username: Username of the user
+            email: Email of the user
             kwargs: The keyword arguments passed through from the filter
         Returns:
-            first_time_discount_eligible (bool): True if the user is eligible for a first time discount
+            is_eligible (bool): True if the user is eligible for a first time discount
         """
         tag = type(self).__name__
 

commerce_coordinator/apps/lms/filters.py

@@ -78,7 +78,7 @@ def run_filter(cls, email):
         """
         Call the PipelineStep(s) defined for this filter.
         Arguments:
-            username: Username of the user
+            email: Email of the user
         Returns:
             is_eligible (bool): True if the user is eligible for a first time discount
         """

commerce_coordinator/apps/lms/views.py

@@ -343,7 +343,7 @@ class FirstTimeDiscountEligibleView(APIView):
     throttle_classes = [UserRateThrottle]
 
     def get(self, request):
-        """Return paginated response of user's order history."""
+        """Return True if user is eligible for a first time discount."""
         email = request.query_params.get('email')
 
         if not email:  # pragma: no cover