doc-gen icon indicating copy to clipboard operation
doc-gen copied to clipboard

Documentation autosearch is not very good

Open BoltonBailey opened this issue 4 years ago • 3 comments

Here is a screenshot of the result when I search for list.map

Screen Shot 2020-12-02 at 3 36 46 PM

As you can see list.map is a real function, but for some reason it is not the first result - I have to look almost to the bottom of the list of hits to find it. When I type in the exact name of the function I'm looking up the docs for, it should be the first hit on the drop down.

BoltonBailey avatar Dec 02 '20 23:12 BoltonBailey

There are plans to overhaul the docs search, but I wouldn't expect changes in the immediate future.

robertylewis avatar Dec 03 '20 19:12 robertylewis

Just another thing I've found to try to convince people this issue is important: In a discussion on the zulip, someone brought up "big_operators" and I didn't know what it was. I searched for it, and got no result. It finally had to be linked to me by someone in the chat.

Screen Shot 2020-12-12 at 5 22 37 PM

BoltonBailey avatar Dec 13 '20 01:12 BoltonBailey

One thing which is very far from obvious at the moment is that clicking the search button does something totally unrelated to the choices in the drop down menu -- it performs a google search on leanprover-community.github.io/mathlib_docs. In this example, it does find a bunch of big_operators hits.

Making that feature more discoverable from the UI somehow could be an easy PR with a decent impact on usability.

bryangingechen avatar Dec 13 '20 04:12 bryangingechen