#34352: Clarify Signals documentation
-------------------------------------+-------------------------------------
Reporter: PASCAL FOUQUE | Owner: nobody
Type: | Status: new
Cleanup/optimization |
Component: Documentation | Version: 4.1
Severity: Normal | Resolution:
Keywords: | Triage Stage:
| Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Comment (by Mariusz Felisiak):
> 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
"callback" is widely used in Python and Django docs as a function that is
passed to another function as an argument, in this case to
`Signal.connect()`. I don't find it confusing, however, we could rename
`my_callback()` to `my_signal_receiver()` to make it even more clearer.
> - 2. Introducing another module name to define "Signal
handlers/Receivers" would help understand this feature involves two
different actors.
Users can freely organize their code, we recommend keeping signal
receivers in `signals.py`. I'm not sure what other module you're
proposing.
> - 3. Unify the naming of "Signal handlers" / "Signal Receiver"
Agreed we could use the same term.
--
Ticket URL: <https://code.djangoproject.com/ticket/34352#comment:1>
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/010701866dd7a9a4-88081430-5b68-4648-b791-61b05c08bb85-000000%40eu-central-1.amazonses.com.
