Fix up sample config

2 files changed, 8 insertions, 4 deletions

diff --git a/docs/sample_config.yaml b/docs/sample_config.yaml

index f242b1ffbc..93aa6a6754 100644
--- a/docs/sample_config.yaml
+++ b/docs/sample_config.yaml
@@ -954,8 +954,10 @@ password_config:
 
 # User Directory configuration
 #
-# 'enabled' defines whether users can search the user directory,
-#  defaults to True.
+# 'enabled' defines whether users can search the user directory. If
+# false then empty responses are returned to all queries. Defaults to
+# true.
+#
 # 'search_all_users' defines whether to search all users visible to your HS
 # when searching the user directory, rather than limiting to users visible
 # in public rooms.  Defaults to false.  If you set it True, you'll have to run
diff --git a/synapse/config/user_directory.py b/synapse/config/user_directory.py

index 9dd83b794d..142754a7dc 100644
--- a/synapse/config/user_directory.py
+++ b/synapse/config/user_directory.py
@@ -37,8 +37,10 @@ class UserDirectoryConfig(Config):
         return """
         # User Directory configuration
         #
-        # 'enabled' defines whether users can search the user directory,
-        # Defaults to true.
+        # 'enabled' defines whether users can search the user directory. If
+        # false then empty responses are returned to all queries. Defaults to
+        # true.
+        #
         # 'search_all_users' defines whether to search all users visible to your HS
         # when searching the user directory, rather than limiting to users visible
         # in public rooms.  Defaults to false.  If you set it True, you'll have to run