search

FathomDocs / fathom

MIT License
0 stars 0 forks source link

Figure out searching #1

Open ryanwersal opened 7 years ago

ryanwersal commented 7 years ago

Searching (specifically quickly) will likely be a feature we're very keen on getting right. Not sure what all should be in here but we should probably get some tentative design thoughts put together regarding how we plan to handle it. I'm also quite interested in the interface we wish to use for searching since additional syntax could be of benefit (like the Sublime Text Command Palette etc and Zeal's searching).

calebhalvy commented 7 years ago

There are a several things I want to focus on in searching:

  1. Zeal has a special syntax in searches where you can specify which docset you want to look in. This is done by adding a prefix, followed by a colon and then your search term. i.e. python: iteritems. This is great if you've loaded many docsets and only actually care about one. This is not without problems, however. You can't distinguish between python2 and python3, likewise qt4 and qt5. It returns results from both. I'd like to include this functionality in fathom, while allowing a search among all versions.

  2. I'd like to include a fuzzy search in the same manner as ST3's command palette. It's really fast when looking for commands or using go to anything(filesearching). Fuzzy search must be fast, which can be difficult.

  3. I'd like to add additional searching to search for terms within docs, not just a basic search of classnames, function names, etc.