Quellcode durchsuchen

Update docs/userguide/signals.rst

add a note about where undocumented keyword parameter (e.g. signal) comes from when implementing a handler.
w- vor 12 Jahren
Ursprung
Commit
65b82a70fa
1 geänderte Dateien mit 6 neuen und 0 gelöschten Zeilen
  1. 6 0
      docs/userguide/signals.rst

+ 6 - 0
docs/userguide/signals.rst

@@ -46,6 +46,12 @@ has been sent by providing the `sender` argument to
                           kwargs=None, **kwds):
         print('Got signal task_sent for task id {0}'.format(task_id)
 
+Signals use the same implementation as django.core.dispatch. As a result other
+keyword parameters (e.g. signal) are passed to all signal handlers by default.
+
+The best practice for signal handlers is to accept arbitrary keyword arguments (**kwargs.
+That way new celery versions can add additional arguments without breaking user code.
+
 .. _signal-ref:
 
 Signals