From 00797738fe16d80093a8b20fbfb012e9d7c5b98c Mon Sep 17 00:00:00 2001 From: Devon Hudson Date: Fri, 21 Jun 2024 13:14:31 -0600 Subject: [PATCH 1/4] Correct error in user_directory docs --- docs/usage/configuration/config_documentation.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/usage/configuration/config_documentation.md b/docs/usage/configuration/config_documentation.md index 22c545359d8..b580f760b41 100644 --- a/docs/usage/configuration/config_documentation.md +++ b/docs/usage/configuration/config_documentation.md @@ -3806,7 +3806,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 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. +* `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 known to the homeserver matching the search query. If false, search results will only contain users visible in public rooms and users sharing a room with the requester. Defaults to false. From 9946f26b8c088ad2e8e58e52ae6a078bf19d342f Mon Sep 17 00:00:00 2001 From: Devon Hudson Date: Fri, 21 Jun 2024 13:16:05 -0600 Subject: [PATCH 2/4] Add changelog entry --- changelog.d/17348.doc | 1 + 1 file changed, 1 insertion(+) create mode 100644 changelog.d/17348.doc diff --git a/changelog.d/17348.doc b/changelog.d/17348.doc new file mode 100644 index 00000000000..c3b762ff32b --- /dev/null +++ b/changelog.d/17348.doc @@ -0,0 +1 @@ +Fixes an error in the docs for `search_all_users` parameter under `user_directory`. From 4ed6747f4f05873eedcbbd6d419695691ca7bfdc Mon Sep 17 00:00:00 2001 From: devonh Date: Mon, 24 Jun 2024 17:08:45 +0000 Subject: [PATCH 3/4] Update changelog.d/17348.doc Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com> --- changelog.d/17348.doc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/changelog.d/17348.doc b/changelog.d/17348.doc index c3b762ff32b..4ce42bbadbc 100644 --- a/changelog.d/17348.doc +++ b/changelog.d/17348.doc @@ -1 +1 @@ -Fixes an error in the docs for `search_all_users` parameter under `user_directory`. +Fix an error in the docs for `search_all_users` parameter under `user_directory`. From c2a4cab865df59dd7b0cf47ceec3d656ef8dd548 Mon Sep 17 00:00:00 2001 From: devonh Date: Mon, 24 Jun 2024 17:09:09 +0000 Subject: [PATCH 4/4] Update docs/usage/configuration/config_documentation.md Co-authored-by: reivilibre --- docs/usage/configuration/config_documentation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/usage/configuration/config_documentation.md b/docs/usage/configuration/config_documentation.md index b580f760b41..cb125edf5ea 100644 --- a/docs/usage/configuration/config_documentation.md +++ b/docs/usage/configuration/config_documentation.md @@ -3806,7 +3806,7 @@ 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 at the time the search is performed. +* `search_all_users`: Defines whether to search all users visible to your homeserver at the time the search is performed. If set to true, will return all users known to the homeserver matching the search query. If false, search results will only contain users visible in public rooms and users sharing a room with the requester.