Update docstring to mention to_device_key

matrix-org · Nov 4, 2021 · d8ebde9 · d8ebde9
1 parent 9eea99c
commit d8ebde9
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 3 deletions.
diff --git a/synapse/config/experimental.py b/synapse/config/experimental.py
@@ -53,5 +53,5 @@ def read_config(self, config: JsonDict, **kwargs):
         # that have opted in to receive them. This setting optionally adds to-device messages
         # to that list.
         self.msc2409_to_device_messages_enabled: bool = experimental.get(
-            "msc2409_to_device_enabled", False
+            "msc2409_to_device_messages_enabled", False
         )
diff --git a/synapse/handlers/appservice.py b/synapse/handlers/appservice.py
@@ -217,8 +217,12 @@ def notify_interested_services_ephemeral(
         Args:
             stream_key: The stream the event came from.
 
-                `stream_key` can be "typing_key", "receipt_key" or "presence_key". Any other
-                value for `stream_key` will cause this function to return early.
+                `stream_key` can be "typing_key", "receipt_key", "presence_key" and,
+                if enabled, "to_device_key". Any other value for `stream_key` will
+                cause this function to return early.
+
+                "to_device_key" will only be handled if the experimental
+                `msc2409_to_device_messages_enabled` config option is set to true.
 
                 Ephemeral events will only be pushed to appservices that have opted into
                 them.