Add brief overview on contact/user

This commit is contained in:
zandercymatics 2024-05-08 10:24:09 -06:00
parent d334f37293
commit adecbdcfc7
No known key found for this signature in database
GPG key ID: FF4636ABEC9682B7
2 changed files with 10 additions and 0 deletions

View file

@ -10,6 +10,11 @@ class Contact(TimeStampedModel):
Contact information follows a similar pattern for each contact. Contact information follows a similar pattern for each contact.
This model uses signals [as defined in [signals.py](../../src/registrar/signals.py)]. This model uses signals [as defined in [signals.py](../../src/registrar/signals.py)].
When a new user is created through Login.gov, a contact object will be created and
associated on the `user` field.
If the `user` object already exists, the underlying user object
will be updated if any updates are made to it through Login.gov.
""" """
user = models.OneToOneField( user = models.OneToOneField(

View file

@ -24,6 +24,11 @@ class User(AbstractUser):
but can be customized later. but can be customized later.
This model uses signals [as defined in [signals.py](../../src/registrar/signals.py)]. This model uses signals [as defined in [signals.py](../../src/registrar/signals.py)].
When a new user is created through Login.gov, a contact object will be created and
associated on the contacts `user` field.
If the `user` object already exists, said user object
will be updated if any updates are made to it through Login.gov.
""" """
class VerificationTypeChoices(models.TextChoices): class VerificationTypeChoices(models.TextChoices):