summary refs log tree commit diff
path: root/docs
diff options
context:
space:
mode:
authorTejaswini Gurram <47633397+tjay27@users.noreply.github.com>2023-01-13 20:16:21 +0530
committerGitHub <noreply@github.com>2023-01-13 14:46:21 +0000
commit1416096527be9fc7edf29a087515f0ac62ce8419 (patch)
treec44cafac99d8a75a6678f13c22167a2caf2402ee /docs
parentDrop unused table `presence` (#14825) (diff)
downloadsynapse-1416096527be9fc7edf29a087515f0ac62ce8419.tar.xz
Update misleading documentation ` user_directory.search_all_users ` (#14818)
Fixes #13852
Diffstat (limited to 'docs')
-rw-r--r--docs/usage/configuration/config_documentation.md4
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/usage/configuration/config_documentation.md b/docs/usage/configuration/config_documentation.md
index 35de9c95e3..3481e866f7 100644
--- a/docs/usage/configuration/config_documentation.md
+++ b/docs/usage/configuration/config_documentation.md
@@ -3472,8 +3472,8 @@ This setting defines options related to the user directory.
 This option has the following sub-options:
 * `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. If false, search results will only contain users
+* `search_all_users`: Defines whether to search all users visible to your HS at the time the search is performed. If set to true, will return all users who share a room with the user from the homeserver.
+   If false, search results will only contain users
     visible in public rooms and users sharing a room with the requester.
     Defaults to false.