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

Simple spell corrector in help doc search #1549

Open
lsheta opened this issue Nov 17, 2020 · 2 comments
Open

Simple spell corrector in help doc search #1549

lsheta opened this issue Nov 17, 2020 · 2 comments

Comments

@lsheta
Copy link
Contributor

lsheta commented Nov 17, 2020

I think the current search bar looks for matches containing the exact string searched for (ex: docs for "Organizations" will show up if I search "Organization" but not if I search "Organzation" or "Organizationss"). Is this a complex problem to solve? Obviously not urgent or anything. Just an idea that might improve usability of the docs.

@susannasiebert
Copy link
Contributor

susannasiebert commented Nov 17, 2020

Read the docs supports a fuzzy search syntax. This requires the users to type their search in in the format search_term~N where N is a number indicating how close to the search term the match is allowed to be, e.g. searching organizationss~2 returns results for organizations (https://civic.readthedocs.io/en/latest/search.html?q=organizationss%7E2&check_keywords=yes&area=default#). However, I haven't found a way to make this the default behavior of the search without the user having to enter this special syntax.

More info on the supported search syntaxes can be found here.

@lsheta
Copy link
Contributor Author

lsheta commented Nov 17, 2020

Thanks for the additional information. I didn't know that fuzzy searches were supported.

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