#34352: Clarify Signals documentation
------------------------------------------------+------------------------
Reporter: PASCAL FOUQUE | Owner: nobody
Type: Cleanup/optimization | Status: new
Component: Documentation | Version: 4.1
Severity: Normal | Keywords:
Triage Stage: Unreviewed | Has patch: 0
Needs documentation: 0 | Needs tests: 0
Patch needs improvement: 0 | Easy pickings: 0
UI/UX: 0 |
------------------------------------------------+------------------------
Currently, the "Signals" documentation presents some inconsistency, mostly
due to naming.
- Different terms are used: "Signal handler", "Signal Receiver",
"callback"
- Users are told to store "Signal handlers/Receivers" into a module called
"signals", which connects to a Signal from another module called "signal".
I think some minor changes, could help understand this feature:
- 1. Remove the term "callback": can lead to confusion with a function
defined per call
- 2. Introducing another module name to define "Signal handlers/Receivers"
would help understand this feature involves two different actors.
- 3. Unify the naming of "Signal handlers" / "Signal Receiver", I'm
wondering if we need to keep both terms, or keep the term "receiver"
reserved for the function and use "Signal Handler" for the connected
function.
NB: I didn't make much research on how this kind of feature is explained
in other frameworks / technologies
--
Ticket URL: <https://code.djangoproject.com/ticket/34352>
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/010701866889d9ef-23fc8954-38a8-4df9-8923-15c3e80d4fb0-000000%40eu-central-1.amazonses.com.
