Docs aren't clear on purpose of signals' "providing_args"

[Nick]

The bottom of the docs says:

If you notice errors with this documentation, please open a ticket and let us know!

Well, I don't know that I would call this an error, so I don't think opening a ticket is the right thing to do. Please let me know if I'm wrong. I would just 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

Do you have to define what the providing arguments are? In my quick tests, the answer to that appears to be "no". Also, there doesn't appear to be a problem with sending a signal without providing an argument listed in "providing_args". So then what's the point of "providing_args"?

Just to be clear, I realize that this group isn't a support group. I'm not asking the question for my own personal benefit. Rather, I'm suggesting that the docs be clarified.

Thanks!

[donarb]

This was discussed a few years ago. At the moment, it's purely documentation(al).

https://groups.google.com/d/msg/django-developers/gV92rX6CPL8/gxj2fwpbbHoJ

 

[Nick]

Thanks for the info. Maybe the docs should state this so others don't run into the same confusion that I ran into?

[Nick]

Should I submit a ticket to have the docs updated?