Skip to content

Commit e01e388

Browse files
committed
chore: Improve some docstrings
1 parent 53f538a commit e01e388

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed

src/viur/shop/modules/order.py

+13-1
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,18 @@ def payment_providers_list( # TODO(discuss): Move: to API?
5555
self,
5656
only_available: bool = True,
5757
) -> JsonResponse[dict[str, PaymentProviderResult]]:
58+
"""
59+
Get a list of payment providers.
60+
61+
This method returns a JSON response containing a dictionary of payment
62+
providers. The keys represent provider identifiers, and the values are
63+
instances of `PaymentProviderResult` (dict) containing the details of each provider.
64+
65+
:param only_available: If ``True`` (default), only payment providers that
66+
are currently available will be included in the response.
67+
If ``False``, all providers will be listed regardless of availability.
68+
:return: A JSON response with a dictionary of payment providers.
69+
"""
5870
return JsonResponse(self.get_payment_providers(only_available))
5971

6072
def get_payment_providers(
@@ -238,7 +250,7 @@ def checkout_start(
238250
order_key: db.Key,
239251
):
240252
"""
241-
Starts the checkout process.
253+
Start the checkout process.
242254
243255
Requires no errors in :meth:`self.can_checkout`.
244256
"""

0 commit comments

Comments
 (0)