Add documentation

This commit is contained in:
Martin Gross
2023-06-30 10:47:28 +02:00
parent 1b1c4358d3
commit fdb2a20514
2 changed files with 6 additions and 1 deletions

View File

@@ -70,6 +70,8 @@ The provider class
.. autoattribute:: settings_form_fields .. autoattribute:: settings_form_fields
.. autoattribute:: walletqueries
.. automethod:: settings_form_clean .. automethod:: settings_form_clean
.. automethod:: settings_content_render .. automethod:: settings_content_render

View File

@@ -449,10 +449,13 @@ class BasePaymentProvider:
@property @property
def walletqueries(self): def walletqueries(self):
""" """
.. warning:: This property is considered **experimental**. It might change or get removed at any time without
prior notice.
A list of wallet payment methods that should be dynamically joined to the public name of the payment method, A list of wallet payment methods that should be dynamically joined to the public name of the payment method,
if they are available to the user. if they are available to the user.
The detection is made on a best effort basis with no guarantees of correctness and actual availability. The detection is made on a best effort basis with no guarantees of correctness and actual availability.
Wallets that pretix can check for are exposed through pretix.base.payment.WalletQueries. Wallets that pretix can check for are exposed through ``pretix.base.payment.WalletQueries``.
""" """
return [] return []