From adecbdcfc745619739af9284300938d321c7a513 Mon Sep 17 00:00:00 2001
From: zandercymatics <141044360+zandercymatics@users.noreply.github.com>
Date: Wed, 8 May 2024 10:24:09 -0600
Subject: [PATCH] Add brief overview on contact/user

---
 src/registrar/models/contact.py | 5 +++++
 src/registrar/models/user.py    | 5 +++++
 2 files changed, 10 insertions(+)

diff --git a/src/registrar/models/contact.py b/src/registrar/models/contact.py
index 6b2344a57..28277df23 100644
--- a/src/registrar/models/contact.py
+++ b/src/registrar/models/contact.py
@@ -10,6 +10,11 @@ class Contact(TimeStampedModel):
     Contact information follows a similar pattern for each contact.
     
     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(
diff --git a/src/registrar/models/user.py b/src/registrar/models/user.py
index 9385b6855..38f9dc05b 100644
--- a/src/registrar/models/user.py
+++ b/src/registrar/models/user.py
@@ -24,6 +24,11 @@ class User(AbstractUser):
     but can be customized later.
 
     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):