Opened 4 years ago

Closed 4 years ago

Last modified 4 years ago

#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


I would like to suggest to the developers that the purpose of "providing_args" be clarified in the docs:

This was a point of confusion for me. According to this post, at the moment, "providing_args" is "purely documentation(al)".

Attachments (1)

19579.diff (526 bytes) - added by Tim Graham 4 years ago.

Download all attachments as: .zip

Change History (5)

comment:1 Changed 4 years ago by Anssi Kääriäinen

Needs documentation: unset
Needs tests: unset
Patch needs improvement: unset
Triage Stage: UnreviewedAccepted

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.

Changed 4 years ago by Tim Graham

Attachment: 19579.diff added

comment:2 Changed 4 years ago by Tim Graham

Has patch: set

comment:3 Changed 4 years ago by Tim Graham <timograham@…>

Resolution: fixed
Status: newclosed

In 4c05fdb467d1de68348401fc47869e8f35dcc278:

Fixed #19579 - Documented that "providing_args" is purely documentational.

comment:4 Changed 4 years ago by Tim Graham <timograham@…>

In 2683e8ea2098dd8d49229497648fa625caab0057:

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

Backport of 4c05fdb467 from master

Note: See TracTickets for help on using tickets.
Back to Top