#31327: Deprecate providing_args argument from Signal
--------------------------------------+------------------------------------
Reporter: Jon Dufresne | Owner: nobody
Type: Cleanup/optimization | Status: new
Component: Utilities | Version: master
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
--------------------------------------+------------------------------------
Changes (by Carlton Gibson):
* stage: Unreviewed => Accepted
Comment:
> On a more practical level, I rarely signals, so I recently had to look
up their interface. Seeing this providing_args argument required me to
think about how to best use it, only to realize it actually goes unused.
We can remove this cognitive distraction from the docs.
Amen to this sentiment. We put every single user through the exact same
mental cycle, for, I agree, very little.
[https://groups.google.com/d/msg/django-
developers/gV92rX6CPL8/gxj2fwpbbHoJ Comment from 2008 on the mailing
list]:
> We went back and forth trying to balance features and performance and
decided to remove the functionality still referenced in the docstring. At
the moment, the providing_args parameter is purely for documentation
purposes, but extra checking may be added in the future if necessary.
I think 12 years later we can accept that this extra never will be added,
and simplify the API.
The signals docs list the parameters.
[https://docs.djangoproject.com/en/3.0/ref/signals/#pre-init For example,
`pre_init`]. I've never thought to look to the source for that. I can't
believe many other folks have either.
--
Ticket URL: <https://code.djangoproject.com/ticket/31327#comment:2>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
--
You received this message because you are subscribed to the Google Groups
"Django updates" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To view this discussion on the web visit
https://groups.google.com/d/msgid/django-updates/067.0226a946d3c7bf5700d7c242096d62e3%40djangoproject.com.
