From 3cf7555f84fe58145e7df7e69166d62a54e0b96c Mon Sep 17 00:00:00 2001
From: Jason Robinson <jasonr@element.io>
Date: Mon, 1 Jun 2026 16:01:30 +0300
Subject: [PATCH] Clarify profile updates sync response with a comment

---
 synapse/handlers/sync.py | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/synapse/handlers/sync.py b/synapse/handlers/sync.py
index 029259e33c..6920a60759 100644
--- a/synapse/handlers/sync.py
+++ b/synapse/handlers/sync.py
@@ -242,6 +242,7 @@ class SyncResult:
     next_batch: StreamToken
     presence: list[UserPresenceState]
     account_data: list[JsonDict]
+    # user ID -> {profile field -> value | null if unset }
     profile_updates: dict[str, dict[str, JsonValue | None]]
     joined: list[JoinedSyncResult]
     invited: list[InvitedSyncResult]
@@ -2239,6 +2240,7 @@ class SyncHandler:
         )
 
         # Serialise the profile updates into the sync response format.
+        # user ID -> {profile field -> value | null if unset }
         profile_updates: dict[str, dict[str, JsonValue | None]] = {}
         for other_user_id, fields in user_fields.items():
             profile_data = profile_data_by_user.get(other_user_id)