Clarify that public/private status is determined by creation preset

matrix-org · Jun 10, 2020 · d95174f · d95174f
1 parent 896beb6
commit d95174f
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/docs/sample_config.yaml b/docs/sample_config.yaml
@@ -1974,7 +1974,8 @@ spam_checker:
 # Possible options are "all", "invite", and "off". They are defined as:
 #
 # * "all": any locally-created room
-# * "invite": any locally-created room that requires an invite to join
+# * "invite": any room created with the "private_chat" or "trusted_private_chat"
+#             room creation presets
 # * "off": this option will take no effect
 #
 # The default value is "off".

diff --git a/synapse/config/room.py b/synapse/config/room.py
@@ -67,7 +67,8 @@ def generate_config_section(self, **kwargs):
         # Possible options are "all", "invite", and "off". They are defined as:
         #
         # * "all": any locally-created room
-        # * "invite": any locally-created room that requires an invite to join
+        # * "invite": any room created with the "private_chat" or "trusted_private_chat"
+        #             room creation presets
         # * "off": this option will take no effect
         #
         # The default value is "off".