From e01c417c1e70b28cba4f5eda6733038eec2eefb4 Mon Sep 17 00:00:00 2001 From: Raphael Michel Date: Thu, 21 Apr 2022 17:17:24 +0200 Subject: [PATCH] Clarify difference between order_modified and order_changed --- src/pretix/base/signals.py | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/src/pretix/base/signals.py b/src/pretix/base/signals.py index ca53316e5..8937dc3bf 100644 --- a/src/pretix/base/signals.py +++ b/src/pretix/base/signals.py @@ -399,7 +399,10 @@ order_modified = EventPluginSignal() Arguments: ``order`` This signal is sent out every time an order's information is modified. The order object is given -as the first argument. +as the first argument. In contrast to ``order_changed``, this signal is sent out if information +of an order or any of it's position is changed that concerns user input, such as attendee names, +invoice addresses or question answers. If the order changes in a material way, such as changed +products, prices, or tax rates, ``order_changed`` is used instead. As with all event-plugin signals, the ``sender`` keyword argument will contain the event. """ @@ -409,7 +412,10 @@ order_changed = EventPluginSignal() Arguments: ``order`` This signal is sent out every time an order's content is changed. The order object is given -as the first argument. +as the first argument. In contrast to ``modified``, this signal is sent out if the order or +any of its positions changes in a material way, such as changed products, prices, or tax rates, +``order_changed`` is used instead. If "only" user input is changed, such as attendee names, +invoice addresses or question answers, ``order_modified`` is used instead. As with all event-plugin signals, the ``sender`` keyword argument will contain the event. """