From 8bd8be7fc48472f16774f3d002068b8bad7c1a17 Mon Sep 17 00:00:00 2001 From: zandercymatics <141044360+zandercymatics@users.noreply.github.com> Date: Wed, 8 May 2024 13:22:57 -0600 Subject: [PATCH] Update README.md --- docs/developer/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/developer/README.md b/docs/developer/README.md index 4e6293854..31a94e6e7 100644 --- a/docs/developer/README.md +++ b/docs/developer/README.md @@ -370,7 +370,7 @@ Per Django, signals "[...allow certain senders to notify a set of receivers that In other words, signals are a mechanism that allows different parts of an application to communicate with each other by sending and receiving notifications when events occur. When an event occurs (such as creating, updating, or deleting a record), signals can automatically trigger specific actions in response. This allows different parts of an application to stay synchronized without tightly coupling the component. -## Rules of use +### Rules of use When using signals, try to adhere to these guidelines: 1. Don't use signals when you can use another method, such as an override of `save()` or `__init__`. 2. Document its usage in this readme (or another centralized location), as well as briefly on the underlying class it is associated with. For instance, since the `handle_profile` directly affects the class `Contact`, the class description notes this and links to [signals.py](../../src/registrar/signals.py).