[1.5.X] Fixed #19579 - Documented that "providing_args" is purely documentational.

Backport of 4c05fdb467 from master
This commit is contained in:
Tim Graham 2013-02-23 15:33:43 -05:00
parent a97c441e18
commit 2683e8ea20
1 changed files with 2 additions and 1 deletions

View File

@ -213,7 +213,8 @@ Defining signals
All signals are :class:`django.dispatch.Signal` instances. The
``providing_args`` is a list of the names of arguments the signal will provide
to listeners.
to listeners. This is purely documentational, however, as there is nothing that
checks that the signal actually provides these arguments to its listeners.
For example: