Opened 3 years ago

Closed 3 years ago

Last modified 3 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

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)

19579.diff (526 bytes) - added by timo 3 years ago.

Download all attachments as: .zip

Change History (5)

comment:1 Changed 3 years ago by akaariai

  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement unset
  • Triage Stage changed from Unreviewed to Accepted

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 3 years ago by timo

comment:2 Changed 3 years ago by timo

  • Has patch set

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

  • Resolution set to fixed
  • Status changed from new to closed

In 4c05fdb467d1de68348401fc47869e8f35dcc278:

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

comment:4 Changed 3 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