Ensure that we document all signals

This commit is contained in:
Raphael Michel
2019-05-09 10:00:18 +02:00
parent 3c7bf46268
commit e87628c902
3 changed files with 4 additions and 17 deletions

View File

@@ -2,16 +2,6 @@ from django.dispatch import Signal
from pretix.base.signals import DeprecatedSignal, EventPluginSignal
restriction_formset = EventPluginSignal(
providing_args=["item"]
)
"""
This signal is sent out to build configuration forms for all restriction formsets
(see plugin API documentation for details).
As with all plugin signals, the ``sender`` keyword argument will contain the event.
"""
html_page_start = Signal(
providing_args=[]
)

View File

@@ -82,7 +82,8 @@ As with all plugin signals, the ``sender`` keyword argument will contain the eve
checkout_flow_steps = EventPluginSignal()
"""
This signal is sent out to retrieve pages for the checkout flow
This signal is sent out to retrieve pages for the checkout flow. Receivers are expected to return
a subclass of ``pretix.presale.checkoutflow.BaseCheckoutFlowStep``.
As with all plugin signals, the ``sender`` keyword argument will contain the event.
"""