Opened 7 years ago

Closed 7 years ago

Last modified 4 years ago

#8236 closed (fixed)

Signals Documentation

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


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 7 years ago by jacob

  • milestone changed from 1.0 beta to 1.0
  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement unset

It's in the works.

comment:2 Changed 7 years ago by jacob

  • Owner changed from nobody to jacob
  • Status changed from new to assigned
  • Triage Stage changed from Unreviewed to Accepted

comment:3 Changed 7 years ago by jacob

  • Resolution set to fixed
  • Status changed from assigned to closed

comment:4 Changed 4 years ago by jacob

  • milestone 1.0 deleted

Milestone 1.0 deleted

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