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

Improve javadoc on SortSpec to inform use of preferredName as a unique key #1905

Closed
nknize opened this issue Jan 14, 2022 · 1 comment
Closed
Labels
documentation Improvements or additions to documentation Search Search query, autocomplete ...etc

Comments

@nknize
Copy link
Collaborator

nknize commented Jan 14, 2022

PR #1856 enhanced the SearchPlugin to enable pluggable SortBuilders. The mechanism uses a new SortSpec to define the specification of the builder and parser and exposes through the named registry. This named registry keys the sort specification off the preferredName which is required to be unique. Contributors may not be aware of other sort builders that share the same name.

This issue is to improve the javadocs to provide better documentation of this requirement.

relates #221

@nknize nknize added documentation Improvements or additions to documentation Indexing & Search labels Jan 14, 2022
@andrross andrross added Search Search query, autocomplete ...etc and removed Indexing & Search labels Feb 29, 2024
@andrross
Copy link
Member

Resolved by #1909

@github-project-automation github-project-automation bot moved this from 🆕 New to ✅ Done in Search Project Board Feb 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation Search Search query, autocomplete ...etc
Projects
Archived in project
Development

No branches or pull requests

2 participants