Fix signal documentation

This commit is contained in:
Raphael Michel
2018-04-12 12:24:32 +02:00
parent dca530f2f2
commit 0201aa9bd1

View File

@@ -91,7 +91,7 @@ should return a list of dictionaries, where each dictionary can have the keys:
* display_size (str, one of "full" (whole row), "big" (half a row) or "small" * display_size (str, one of "full" (whole row), "big" (half a row) or "small"
(quarter of a row). May be ignored on small displays, default is "small") (quarter of a row). May be ignored on small displays, default is "small")
* priority (int, used for ordering, higher comes first, default is 1) * priority (int, used for ordering, higher comes first, default is 1)
* link (str, optional, if the full widget should be a link) * url (str, optional, if the full widget should be a link)
As with all plugin signals, the ``sender`` keyword argument will contain the event. As with all plugin signals, the ``sender`` keyword argument will contain the event.
An additional keyword argument ``subevent`` *can* contain a sub-event. An additional keyword argument ``subevent`` *can* contain a sub-event.
@@ -108,7 +108,7 @@ should return a list of dictionaries, where each dictionary can have the keys:
* display_size (str, one of "full" (whole row), "big" (half a row) or "small" * display_size (str, one of "full" (whole row), "big" (half a row) or "small"
(quarter of a row). May be ignored on small displays, default is "small") (quarter of a row). May be ignored on small displays, default is "small")
* priority (int, used for ordering, higher comes first, default is 1) * priority (int, used for ordering, higher comes first, default is 1)
* link (str, optional, if the full widget should be a link) * url (str, optional, if the full widget should be a link)
This is a regular django signal (no pretix event signal). This is a regular django signal (no pretix event signal).
""" """