From cd520dec4321b68df3d254bb42555086626fd851 Mon Sep 17 00:00:00 2001 From: tjay27 Date: Wed, 11 Jan 2023 18:31:12 +0530 Subject: [PATCH 1/4] Update incomplete documentation of user_directory.search_all_users --- docs/usage/configuration/config_documentation.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/usage/configuration/config_documentation.md b/docs/usage/configuration/config_documentation.md index 294dd6edddcd..a24e5e7853e7 100644 --- a/docs/usage/configuration/config_documentation.md +++ b/docs/usage/configuration/config_documentation.md @@ -3472,8 +3472,9 @@ 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 when searching + the user directory. 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. From a283328fbd7fe2416d90aad70a0e9dda17432683 Mon Sep 17 00:00:00 2001 From: tjay27 Date: Wed, 11 Jan 2023 18:32:25 +0530 Subject: [PATCH 2/4] Update documentation of user_directory.search_all_users --- docs/usage/configuration/config_documentation.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/usage/configuration/config_documentation.md b/docs/usage/configuration/config_documentation.md index a24e5e7853e7..ff9fd804fd96 100644 --- a/docs/usage/configuration/config_documentation.md +++ b/docs/usage/configuration/config_documentation.md @@ -3472,8 +3472,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 when searching - the user directory. 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 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. From 48716d3448658029c67e6f775ee0b6604374693f Mon Sep 17 00:00:00 2001 From: tjay27 Date: Wed, 11 Jan 2023 18:58:43 +0530 Subject: [PATCH 3/4] update change log --- changelog.d/14818.doc | 1 + 1 file changed, 1 insertion(+) create mode 100644 changelog.d/14818.doc diff --git a/changelog.d/14818.doc b/changelog.d/14818.doc new file mode 100644 index 000000000000..8dda9567ded4 --- /dev/null +++ b/changelog.d/14818.doc @@ -0,0 +1 @@ +Updated documentation in configuration manual for user_directory.search_all_users \ No newline at end of file From fe4ed3923d8135bc17a2eb3ef71a9a564f7fb005 Mon Sep 17 00:00:00 2001 From: Erik Johnston Date: Fri, 13 Jan 2023 14:11:03 +0000 Subject: [PATCH 4/4] Update changelog.d/14818.doc --- changelog.d/14818.doc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/changelog.d/14818.doc b/changelog.d/14818.doc index 8dda9567ded4..7a47cc8ab35e 100644 --- a/changelog.d/14818.doc +++ b/changelog.d/14818.doc @@ -1 +1 @@ -Updated documentation in configuration manual for user_directory.search_all_users \ No newline at end of file +Updated documentation in configuration manual for `user_directory.search_all_users`. \ No newline at end of file