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

SearchDef parameter "hint" has a confusing name #4

Open
xmkg opened this issue May 2, 2023 · 0 comments
Open

SearchDef parameter "hint" has a confusing name #4

xmkg opened this issue May 2, 2023 · 0 comments

Comments

@xmkg
Copy link
Contributor

xmkg commented May 2, 2023

The SearchDef parameter "hint" is defined as an optional parameter with the following description:

optional pre-search term. If provided, this is expected to match in order for the main search to be executed

where the effects of the parameter are not that obvious when the description for the "hint" parameter is not read by the user downstream. The name "hint" suggests that it's optional, it'll help the SearchDef to do its' job better (e.g., performance optimization), and it's not necessary to provide the core functionality (i.e. the match result would be the same with/without the "hint" parameter), but it's definitely doing more than that.

The parameter may be better understood if we rename it to sth like "prefilter".

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

1 participant