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

Ideas for search bar improvments #822

Open
tristanlatr opened this issue Oct 3, 2024 · 0 comments
Open

Ideas for search bar improvments #822

tristanlatr opened this issue Oct 3, 2024 · 0 comments

Comments

@tristanlatr
Copy link
Contributor

tristanlatr commented Oct 3, 2024

  • Give better ranking when an object matches multiple clauses, I think this is already done by lunr. But some queries will generate unexpected result ordering. Like ensure parsed will not yield ensure_parsed_docstring as the first result in the list.
  • astutils. should list all members of the pydoctor.astutils module (translated to astutils.* *.astutils.* in lunr syntax) This has been addressed in Search bar improvments and Help page #823
  • Add wildcard in between dots so users can use only the first letters of module names, liket.w.t.tag might be translated to t*.w*.t*.tag* *.t*.w*.t*.tag* in lunr syntax
  • Change the default logic operator in between clauses: Currently all clauses are ORed together, so the number of results will increase every time users enter a new clause. Which is not a great user experience IMO. We could ANd the clauses by default and add a button to change the search logic.
  • Another way of fixing the issue above is to ANd the clauses together if no clauses have an explicit presence, so foo bar would become +foo +bar and +foo bar would stay the same. As a side effect this will make impossible to define query with only optional terms.
tristanlatr added a commit that referenced this issue Oct 4, 2024
tristanlatr added a commit that referenced this issue Nov 26, 2024
- Implement one idea described in #822, more specifically: add a leading wildcard to the query when the term contains a dot ".".

- Fixes #819

- Move the NotFoundLinker to the linker.py module because t's now used by the help page renderer.
Simplify the readthedocs theme and fix an issue that prevented to use the search bar from the module index page and other summary pages.
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