Remove search-all-docs, add checkbox "Also search doc string" #11

Closed
jafingerhut opened this Issue Apr 20, 2012 · 4 comments

Comments

Projects
None yet
2 participants
Collaborator

jafingerhut commented Apr 20, 2012

My addition of the choice search-all-docs in the Vars menu is kind of a hack. It would be more orthogonal if there was a check box labeled something like "Also search doc string".

When that box was not checked, then any regex pattern typed into the text box above the vars list would be used to match against the symbol names only.

When the box was checked, the regex pattern would be matched against the symbol names and the doc strings.

Another possibility is to have yet another check box to enable searching for regex matches within the ClojureDocs examples or comments.

Owner

franks42 commented Apr 20, 2012

Agreed - but where to put the check-box…. maybe next to filter, or maybe on the bottom?

Maybe only search the clojuredocs when you work off-line...

On Apr 20, 2012, at 3:30 AM, Andy Fingerhut wrote:

My addition of the choice search-all-docs in the Vars menu is kind of a hack. It would be more orthogonal if there was a check box labeled something like "Also search doc string".

When that box was not checked, then any regex pattern typed into the text box above the vars list would be used to match against the symbol names only.

When the box was checked, the regex pattern would be matched against the symbol names and the doc strings.

Another possibility is to have yet another check box to enable searching for regex matches within the ClojureDocs examples or comments.


Reply to this email directly or view it on GitHub:
#11

Collaborator

jafingerhut commented Apr 20, 2012

I forgot to mention that clojuredocs searching only really makes sense if you are offline. Agreed that it would be at least impolite to slam clojuredocs.org web site with searches like that, and I don't believe they currently even support such content-based searches anyway.

As for where to put the check-box, I think it would be good to put it close to the widget that it affects the behavior of functionally, which is the text box where you enter a pattern to match against the var names. If it doesn't fit easily in the existing width of that column, perhaps just above that text box, and below the popup menu?

Collaborator

jafingerhut commented Apr 20, 2012

A menu item might be preferable to avoid too many widgets that are displayed all the time. I would guess the user wouldn't change it so often that a menu item is inconvenient.

Collaborator

jafingerhut commented Apr 24, 2012

Frank recently added menu item Vars -> Search Docs Also and with most recent Apr 24 2012 commit, it should do what it implies.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment