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

Revert "Adds fuzzy search for help search dialog" #39990

Merged
merged 1 commit into from
Jun 30, 2020

Conversation

follower
Copy link
Contributor

This reverts commit 481dbce.

Current fuzzy search implementation results in too many
non-useful results.

Could be re-added after result sort/filter/score functionality
is added. See #30072 for example existing implementation.

Fixes: #39128

Reverts: #32043

Fixed format style conflicts:

  • editor/editor_help_search.cpp

This reverts commit 481dbce.

Current fuzzy search implementation results in too many
non-useful results.

Could be re-added after result sort/filter/score functionality
is added. See godotengine#30072 for example existing implementation.

Fixes: godotengine#39128

Reverts: godotengine#32043

Fixed format style conflicts:
	editor/editor_help_search.cpp
@follower
Copy link
Contributor Author

Search term example screenshots:

  • abs

    post-revert--search-term--abs

  • cache

    post-revert--search-term--cache

  • hex

    post-revert--search-term--hex

  • search

    post-revert--search-term--search

  • stor

    post-revert--search-term--stor

  • store

    post-revert--search-term--store

  • kin2 (no results due to removal of fuzzy search):

    post-revert--search-term--kin2

  • nine (indicates exact match prefixes would still benefit from prioritisation):

    post-revert--search-term--nine

@akien-mga akien-mga added cherrypick:3.x Considered for cherry-picking into a future 3.x release discussion enhancement topic:editor usability labels Jun 30, 2020
@akien-mga akien-mga added this to the 4.0 milestone Jun 30, 2020
@akien-mga
Copy link
Member

Seems better to me to go back to the previous behavior indeed, I agree that the fuzzy search is not so useful (unless you know exactly what you're searching for and want to be able to find it even if you make typos, which I guess might have been @guilhermefelipecgs's motivation for #32043?).

@follower
Copy link
Contributor Author

[Written at same time as @akien-mga's comment. :) ]

I think this is even more important in view of the significant and non-backwards 4.0 changes which will result in almost everyone not having experience with the changed functionality and potentially using help search more often.

I think ideally we could support fuzzy matching and have useful non-fuzzy results but obviously that's additional effort.

Also, wanted to ping @guilhermefelipecgs as the original author of the reverted commit as a courtesy & in case they wish to look at incorporating sort/filter/scoring functionality such as used in #30072. It would also be helpful to have more examples of "fuzzy" searches with the desired results to help with scoring/sorting of results.

Thanks!

Copy link
Contributor

@guilhermefelipecgs guilhermefelipecgs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree that we need to add some type of scoring system to improve the search. When I implemented this I used it to speed up my queries, but I usually know what I'm looking for :)

@guilhermefelipecgs
Copy link
Contributor

guilhermefelipecgs commented Jun 30, 2020

But I'm not sure how to improve this. I'll think about it.

@akien-mga akien-mga merged commit 84e9e58 into godotengine:master Jun 30, 2020
@akien-mga
Copy link
Member

Thanks!

@follower
Copy link
Contributor Author

follower commented Jul 1, 2020

@guilhermefelipecgs If you do go down this path I'd strongly recommend looking at https://github.com/godotengine/godot/pull/30072/files which I'm sure could probably just be copied & pasted. ;)

Also useful starting points:

I suspect what may need to happen is that the existing semi-duplicated code performing similar filter/score/sorting processing could be extracted into a more generic helper.

@akien-mga
Copy link
Member

Cherry-picked for 3.2.3.

@akien-mga akien-mga removed the cherrypick:3.x Considered for cherry-picking into a future 3.x release label Jul 3, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Editor "Search Help" fuzzy search results are significantly less helpful
3 participants