Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Documentation] Error in the user directory configuration description #17016

Closed
giomfo opened this issue Mar 21, 2024 · 1 comment
Closed

[Documentation] Error in the user directory configuration description #17016

giomfo opened this issue Mar 21, 2024 · 1 comment

Comments

@giomfo
Copy link
Member

giomfo commented Mar 21, 2024

Description:

For my point of view there is a typo in the current description of the search_all_users parameter in config_documentation.md.

This sentence: "If set to true, will return all users who share a room with the user from the homeserver." is not correct.

The right description for this value true is available in user_directory.md: "if search_all_users is true, no such limits are placed and all users known to the server (matching the search query) will be returned."

The following example helps to understand the meaning of users known to the server:
"Consider Alice, a user on server A, and Bob, a user on server B. Also consider that both servers have search_all_users set to true. Currently, Alice can only discover Bob (through the user directory) if server A is in a room that Bob is joined to."

@devonh
Copy link
Member

devonh commented Jun 21, 2024

I agree with your assessment.
See this PR for revised docs: #17348

@devonh devonh closed this as completed Jun 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants