Skip to content

Search option is case sensitive(?) #2328

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

Closed
pieterlukasse opened this issue Jul 21, 2016 · 10 comments
Closed

Search option is case sensitive(?) #2328

pieterlukasse opened this issue Jul 21, 2016 · 10 comments
Labels
Improvement Minor improvement to code Needed: design decision A core team decision is required

Comments

@pieterlukasse
Copy link

Details

Expected Result

I would like the search to be case insensitive.

Actual Result

When using the search option, I noticed that it only finds results when the case is matching. This should not be the case. Example: searching for cbioportalImporter.py or cbioportalimporter.py in the documentation URL above gives different results (in this case only the first one results in matches).

@smrgit
Copy link

smrgit commented Sep 1, 2016

I have also experienced this -- is there a way to make searches case-insensitive? or are there any options for how the search is performed?

@pieterlukasse
Copy link
Author

I have not found one. I hope the developers here can give this some priority...

@smrgit
Copy link

smrgit commented Sep 6, 2016

@pieterlukasse within the past couple of days things seem to have changed -- can you confirm that the search now seems to be case-insensitive? (or could it be a browser issue in some strange way?) another thing I'm noticing it is that partial-word searching doesn't work which was my attempted-work-around to avoid having to choose whether the first letter was upper- or lower-case ...

@pieterlukasse
Copy link
Author

@smrgit no, searching for cbioportalimporter.py in referred documentation still gives no results. When I use only cbioportalimporter, then I get some results (also in different case). So maybe it is improved a bit...but not quite there yet.

@humitos humitos added Improvement Minor improvement to code Needed: design decision A core team decision is required labels Mar 9, 2017
@humitos humitos added this to the Search milestone Mar 23, 2018
@agjohnson agjohnson modified the milestones: Search, Search improvements Mar 29, 2018
@safwanrahman
Copy link
Member

@ericholscher If anyone wants to have a case sensitive search, what they will need to do then?

@ericholscher
Copy link
Member

I don't know if we need to support case sensitive, but perhaps we could support it with quotes. ""importedFile" for example.

@ericholscher
Copy link
Member

@safwanrahman would be good to add some tests to confirm this, and then we can call it done, and will catch any regressions if they happen.

@ericholscher ericholscher added the Accepted Accepted issue on our roadmap label Jun 19, 2018
@ericholscher
Copy link
Member

So:

  • The default search should always return things in any case (case insensitive)

We need to decide if we want to support the ability to search case sensitive, and how it would work. One idea would be to quote things "ImportedFile" -- but I worry, as it would also make "run the tests" not return results for Run the tests. So we should think more about how to implement case sensitivity, and perhaps choose not to implement it at all.

ericholscher added a commit that referenced this issue Jun 21, 2018
[Fix #2328 #2013] Refresh search index and test for case insensitive search
@ericholscher
Copy link
Member

This has been fixed in our new search code. It will be deployed in the next month or so, so closing this issue as it's been addressed.

@safwanrahman
Copy link
Member

I am reopening this issue because I believe there should be case sensitive search also.
While I search in RTD, sometimes I would like to search for a specific class like Foo. Currently, it gives me proper result. but after my fix has been deployed, It will return all the result where there are foo, Foo, FOO, fOO, fOo etc. So it will really break the search experience of many of the user.
I think a design decission is needed.
We can give Case Sensitive match more wight, and insensitive match lower weight. So both type of result comes to the search result, but Case Sensitive gets higher priority.
What do you think @ericholscher @agjohnson @davidfischer

@safwanrahman safwanrahman reopened this Jun 22, 2018
@safwanrahman safwanrahman removed the Accepted Accepted issue on our roadmap label Jun 22, 2018
safwanrahman pushed a commit to safwanrahman/readthedocs.org that referenced this issue Jul 16, 2018
[Fix readthedocs#2328 readthedocs#2013] Refresh search index and test for case insensitive search
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Improvement Minor improvement to code Needed: design decision A core team decision is required
Projects
None yet
Development

No branches or pull requests

6 participants