This repository has been archived by the owner on Feb 20, 2019. It is now read-only.
Document the new user.search_min_length setting #4072
Merged
+12
−0
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@phil-davis, I'm not sure if this is sufficient. However, it seemed like the best place to document it (in the user, admin, and dev manuals). Please let me know your feedback, and I'll implement it as best as possible. |
phil-davis
reviewed
Apr 23, 2018
user_manual/files/webgui/sharing.rst
Outdated
| From 10.0.8, user and group name search results are dependent on a new | ||
| `configuration setting`_, called ``user.search_min_length`` (it is set to 4 by | ||
| default). | ||
| This setting helps to aid search performance but requires that searches |
user_manual/files/webgui/sharing.rst
Outdated
| will return no results. | ||
| There is one exception, however. | ||
| If an existing user or group has a name shorter than ``search_min_length``, | ||
| then it will always be returned in the search results. |
There was a problem hiding this comment.
Maybe:
Consequently, search terms shorter than the defined number of characters
will not return a list of matches.
However, they will return an existing user or group with a name of the same
length as the search term.
(I am trying hard not to use the word "exact" because then it has to be qualified with "case-insensitive" somewhere)
There was a problem hiding this comment.
That last part's more succinct than my version. It took me ages to find a description that was concise enough. Your suggestions definitely improve what I wrote.
It provides a short introduction to and description of the setting, so that users are aware that it's in place. This will also be documented in the respective mobile app manuals, and in the config sample guide. This fixes #4040.
cd31cf6 to
ff2042b
Compare
|
All changes implemented, @phil-davis |
phil-davis
approved these changes
Apr 23, 2018
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds a short introduction to and description of the
user.search_min_lengthsetting, so that users are aware of it. It will also be documented in the respective mobile app manuals, and in the config sample guide.Implements
#4040.