summary refs log tree commit diff
diff options
context:
space:
mode:
authorErik Johnston <erik@matrix.org>2019-03-20 14:24:53 +0000
committerErik Johnston <erik@matrix.org>2019-03-20 14:24:53 +0000
commit926f29ea6d820d1d14fb5677fe948fa2e15d748e (patch)
tree128e7ca7cc9b4a1749fc6526aa2982071bd8b8ea
parentNewsfile (diff)
downloadsynapse-926f29ea6d820d1d14fb5677fe948fa2e15d748e.tar.xz
Fix up config comments
-rw-r--r--docs/sample_config.yaml7
-rw-r--r--synapse/config/room_directory.py7
2 files changed, 8 insertions, 6 deletions
diff --git a/docs/sample_config.yaml b/docs/sample_config.yaml
index f7b1825d61..d1a419b240 100644
--- a/docs/sample_config.yaml
+++ b/docs/sample_config.yaml
@@ -1036,10 +1036,11 @@ password_config:
 
 
 
-# Wether the public room list can be searched. When disabled blocks
-# searching local and remote room list for local and remote users.
+# Uncomment to disable searching the public room list. When disabled
+# blocks searching local and remote room lists for local and remote
+# users by always returning an empty list for all queries.
 #
-#enable_room_list_search: true
+#enable_room_list_search: false
 
 # The `alias_creation` option controls who's allowed to create aliases
 # on this server.
diff --git a/synapse/config/room_directory.py b/synapse/config/room_directory.py
index a25a41d16d..8a9fded4c5 100644
--- a/synapse/config/room_directory.py
+++ b/synapse/config/room_directory.py
@@ -58,10 +58,11 @@ class RoomDirectoryConfig(Config):
 
     def default_config(self, config_dir_path, server_name, **kwargs):
         return """
-        # Wether the public room list can be searched. When disabled blocks
-        # searching local and remote room list for local and remote users.
+        # Uncomment to disable searching the public room list. When disabled
+        # blocks searching local and remote room lists for local and remote
+        # users by always returning an empty list for all queries.
         #
-        #enable_room_list_search: true
+        #enable_room_list_search: false
 
         # The `alias_creation` option controls who's allowed to create aliases
         # on this server.