From e892457a03787e844ba291acc9bfa9455e854145 Mon Sep 17 00:00:00 2001
From: Erik Johnston <erik@matrix.org>
Date: Wed, 15 Mar 2017 14:50:33 +0000
Subject: Comment

---
 synapse/handlers/presence.py | 3 +++
 1 file changed, 3 insertions(+)

(limited to 'synapse/handlers/presence.py')

diff --git a/synapse/handlers/presence.py b/synapse/handlers/presence.py
index 46704c62a0..f714bcb53d 100644
--- a/synapse/handlers/presence.py
+++ b/synapse/handlers/presence.py
@@ -984,6 +984,9 @@ def should_notify(old_state, new_state):
 def format_user_presence_state(state, now, include_user_id=True):
     """Convert UserPresenceState to a format that can be sent down to clients
     and to other servers.
+
+    The "user_id" is optional so that this function can be used to format presence
+    updates for client /sync responses and for federation /send requests.
     """
     content = {
         "presence": state.state,
-- 
cgit 1.4.1