Update misleading documentation user_directory.search_all_users (#14818)

Fixes #13852
This commit is contained in:
Tejaswini Gurram 2023-01-13 20:16:21 +05:30 committed by GitHub
parent 8d5325ec0c
commit 1416096527
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 3 additions and 2 deletions

1
changelog.d/14818.doc Normal file
View File

@ -0,0 +1 @@
Updated documentation in configuration manual for `user_directory.search_all_users`.

View File

@ -3472,8 +3472,8 @@ This setting defines options related to the user directory.
This option has the following sub-options: This option has the following sub-options:
* `enabled`: Defines whether users can search the user directory. If false then * `enabled`: Defines whether users can search the user directory. If false then
empty responses are returned to all queries. Defaults to true. 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 * `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.
the user directory. If false, search results will only contain users If false, search results will only contain users
visible in public rooms and users sharing a room with the requester. visible in public rooms and users sharing a room with the requester.
Defaults to false. Defaults to false.