From fdb2a20514dcb838d162f250b658e9d10f83f318 Mon Sep 17 00:00:00 2001 From: Martin Gross Date: Fri, 30 Jun 2023 10:47:28 +0200 Subject: [PATCH] Add documentation --- doc/development/api/payment.rst | 2 ++ src/pretix/base/payment.py | 5 ++++- 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/doc/development/api/payment.rst b/doc/development/api/payment.rst index a09844213..052dce71d 100644 --- a/doc/development/api/payment.rst +++ b/doc/development/api/payment.rst @@ -70,6 +70,8 @@ The provider class .. autoattribute:: settings_form_fields + .. autoattribute:: walletqueries + .. automethod:: settings_form_clean .. automethod:: settings_content_render diff --git a/src/pretix/base/payment.py b/src/pretix/base/payment.py index e18d7b764..de0dc8eab 100644 --- a/src/pretix/base/payment.py +++ b/src/pretix/base/payment.py @@ -449,10 +449,13 @@ class BasePaymentProvider: @property 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, if they are available to the user. 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 []