CGM_Public/pretix_original
2
0
Fork 1
mirror of https://github.com/pretix/pretix.git synced 2026-05-04 15:04:03 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fix documentation for override_layout signal

Browse Source
This commit is contained in:
Martin Gross
2019-11-15 15:54:50 +01:00
parent 600310da0f
commit 46ce9904cd
1 changed files with 2 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
src/pretix/plugins/ticketoutputpdf/signals.py
View File

@@ -126,14 +126,14 @@ def pdf_logentry_object_link(sender, logentry, **kwargs):
override_layout = EventPluginSignal(
providing_args=["layout", "position"]
providing_args=["layout", "orderposition"]
)
"""
This signal allows you to forcefully override the ticket layout that is being used to create the ticket PDF. Use with
care, as this will render any specifically by the organizer selected templates useless.
The ``layout`` keyword argument will contain the layout which has been originally selected by the system, the
``position`` keyword argument will contain the ``OrderPosition`` which is being generated.
``orderposition`` keyword argument will contain the ``OrderPosition`` which is being generated.
If you implement this signal and do not want to override the layout, make sure to return the ``layout`` keyword argument
which you have been passed.