Skip to content

Commit 805e6c9

Browse files
devonhanoadragon453reivilibre
authored
Correct error in user_directory docs (#17348)
### Pull Request Checklist <!-- Please read https://element-hq.github.io/synapse/latest/development/contributing_guide.html before submitting your pull request --> * [X] Pull request is based on the develop branch * [X] Pull request includes a [changelog file](https://element-hq.github.io/synapse/latest/development/contributing_guide.html#changelog). The entry should: - Be a short description of your change which makes sense to users. "Fixed a bug that prevented receiving messages from other servers." instead of "Moved X method from `EventStore` to `EventWorkerStore`.". - Use markdown where necessary, mostly for `code blocks`. - End with either a period (.) or an exclamation mark (!). - Start with a capital letter. - Feel free to credit yourself, by adding a sentence "Contributed by @github_username." or "Contributed by [Your Name]." to the end of the entry. * [X] [Code style](https://element-hq.github.io/synapse/latest/code_style.html) is correct (run the [linters](https://element-hq.github.io/synapse/latest/development/contributing_guide.html#run-the-linters)) --------- Co-authored-by: Andrew Morgan <[email protected]> Co-authored-by: reivilibre <[email protected]>
1 parent 3c61ddb commit 805e6c9

File tree

2 files changed

+3
-1
lines changed

2 files changed

+3
-1
lines changed

changelog.d/17348.doc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Fix an error in the docs for `search_all_users` parameter under `user_directory`.

docs/usage/configuration/config_documentation.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3807,7 +3807,8 @@ This setting defines options related to the user directory.
38073807
This option has the following sub-options:
38083808
* `enabled`: Defines whether users can search the user directory. If false then
38093809
empty responses are returned to all queries. Defaults to true.
3810-
* `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.
3810+
* `search_all_users`: Defines whether to search all users visible to your homeserver at the time the search is performed.
3811+
If set to true, will return all users known to the homeserver matching the search query.
38113812
If false, search results will only contain users
38123813
visible in public rooms and users sharing a room with the requester.
38133814
Defaults to false.

0 commit comments

Comments
 (0)