#19579 closed Uncategorized (fixed)
Docs aren't clear on purpose of signals' "providing_args"
| Reported by: | anonymous | Owned by: | nobody |
|---|---|---|---|
| Component: | Documentation | Version: | 1.4 |
| Severity: | Normal | Keywords: | |
| Cc: | Triage Stage: | Accepted | |
| Has patch: | yes | Needs documentation: | no |
| Needs tests: | no | Patch needs improvement: | no |
| Easy pickings: | no | UI/UX: | no |
Description
I would like to suggest to the developers that the purpose of "providing_args" be clarified in the docs:
https://docs.djangoproject.com/en/dev/topics/signals/#defining-signals
This was a point of confusion for me. According to this post, at the moment, "providing_args" is "purely documentation(al)".
Attachments (1)
Change History (5)
comment:1 by , 11 years ago
| Triage Stage: | Unreviewed → Accepted |
|---|
by , 11 years ago
| Attachment: | 19579.diff added |
|---|
comment:2 by , 11 years ago
| Has patch: | set |
|---|
comment:3 by , 11 years ago
| Resolution: | → fixed |
|---|---|
| Status: | new → closed |
Note:
See TracTickets
for help on using tickets.
We could likely check that the args in send() match providing_args, but that might be somewhat costly. Maybe if settings.DEBUG = True then we do the checking, otherwise not? I think we could arrange the code in such a way that there is zero overhead when settings.DEBUG = False.
Marking as accepted for the documentation part.