Opened 15 years ago

Closed 15 years ago

Last modified 12 years ago

#8236 closed (fixed)

Signals Documentation

Reported by: Greg Taylor Owned by: Jacob
Component: Core (Other) Version: dev
Severity: Keywords: signals
Cc: Triage Stage: Accepted
Has patch: no Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: no UI/UX: no


Signals have been un-documented for as long as I can remember. To introduce a backwards-incompatible change minus any documentation at all is a major "bug" in that those of us unfamiliar with Django internals are now unable to follow trunk until some kind of documentation is released. While it's not difficult to see how to define custom signals from the BackwardsIncompatible wiki page, there's no mention of how to handle built-in pre_save and other similar signals on a per-model basis. Plus, relying on a very brief scribble on an obscure wiki page is sure to cause lots of unecessary changes.

While the signals rewrite is still fresh on the minds of the developers, please take 15 minutes to document this so we've got something sturdy to go from. Previously a few blogs had produced some very high quality documentation for signals, but we're pretty much "stranded" right now.

Change History (4)

comment:1 Changed 15 years ago by Jacob

milestone: 1.0 beta1.0

It's in the works.

comment:2 Changed 15 years ago by Jacob

Owner: changed from nobody to Jacob
Status: newassigned
Triage Stage: UnreviewedAccepted

comment:3 Changed 15 years ago by Jacob

Resolution: fixed
Status: assignedclosed

comment:4 Changed 12 years ago by Jacob

milestone: 1.0

Milestone 1.0 deleted

Note: See TracTickets for help on using tickets.
Back to Top