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

Feature request: make association of "gstyle" with "Google Style" search queries more obvious #140

Open
githubisviolatingthegpl opened this issue Jun 25, 2024 · 0 comments

Comments

@githubisviolatingthegpl

Hi, long-time enjoyer of sncli (about 5 years) here, so thanks for this wonderful program.

I have a feature suggestion regarding how google-style search is mentioned in the help screen:

I had made a copy of the kb_help 'h' screen and was perusing it again just a few minutes ago, and I noticed (not for the first time) that there's two search modes, "gstyle" and "regex."

I figured that "gstyle" was a common search syntax I wasn't familiar with, so I went looking for it online, but couldn't find anything. So, I cloned the git repo and searched for "gstyle" in the source code, and saw that docs/configuration.rst mentions "gstyle," and just above that, "Google style search." The lightbulb came on! 😄

I searched the README.md for any reference of gstyle, and saw that it only mentions "Google Style" (which it does a great job of explaining).

I was wondering if it would be possible to have some reference to "Google Style" search in the kb_help screen (there's just enough room to replace Search using gstyle with Google-style search), and/or add a mention of "gstyle" in the README.md, so that it can be more easily found? I don't know if I'm the only one who didn't make the connection between "gstyle" and "Google Style." :D

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant