zydronium/manage.get.gov
1
0
Fork 0
mirror of https://github.com/cisagov/manage.get.gov.git synced 2025-05-15 09:07:02 +02:00
Code Issues Projects Releases Packages Wiki Activity

Swap order

Browse source
This commit is contained in:
zandercymatics 2024-05-08 13:19:53 -06:00
parent 7c3e03a240
commit c52a7ee0a9
No known key found for this signature in database
GPG key ID: FF4636ABEC9682B7
1 changed files with 4 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

8
docs/developer/README.md
View file

@ -372,10 +372,10 @@ In other words, signals are a mechanism that allows different parts of an applic
## Rules of use ## Rules of use
When using signals, try to adhere to these guidelines: When using signals, try to adhere to these guidelines:
1. 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). 1. Don't use signals when you can use another method, such as an override of `save()` or `__init__`.
2. Where possible, avoid chaining signals together (i.e. a signal that calls a signal). If this has to be done, clearly document the flow. 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).
3. Minimize logic complexity within the signal as much as possible. 3. Where possible, avoid chaining signals together (i.e. a signal that calls a signal). If this has to be done, clearly document the flow.
4. Don't use signals when you can use another method, such as an override of `save()` or `__init__`. 4. Minimize logic complexity within the signal as much as possible.
### When should you use signals? ### When should you use signals?
Generally, you would use signals when you want an event to be synchronized across multiple areas of code at once (such as with two models or more models at once) in a way that would otherwise be difficult to achieve by overriding functions. Generally, you would use signals when you want an event to be synchronized across multiple areas of code at once (such as with two models or more models at once) in a way that would otherwise be difficult to achieve by overriding functions.