Opened 6 years ago

Closed 5 years ago

#11359 closed (fixed)

"Built-in signals" API reference doc fails to mention "Signals" documentation.

Reported by: tyson Owned by: nobody
Component: Documentation Version: master
Severity: Keywords: signals documentation
Cc: Triage Stage: Ready for checkin
Has patch: no Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: UI/UX:

Description

There is a "See also" section at the top of the Signals API reference which includes a link to documentation of signals in the comments app, but no "see also" describing how to use signals.

Add a link to the "Using Django" > "Signals" document in the "See also" section, probably with text similar to what is seen in the comments signals reference:

See the introduction to signals for information about how to register for and receive these signals.

Attachments (1)

11359.diff (511 bytes) - added by timo 6 years ago.

Download all attachments as: .zip

Change History (3)

Changed 6 years ago by timo

comment:1 Changed 6 years ago by timo

  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement unset
  • Triage Stage changed from Unreviewed to Ready for checkin

comment:2 Changed 5 years ago by russellm

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

(In [11540]) Fixed #11359 -- Added a link to the signals topic guide in the signals reference. Thanks to tyson for the suggestion.

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