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

Documentation request #3

Open
PaulRivier opened this issue May 4, 2020 · 3 comments
Open

Documentation request #3

PaulRivier opened this issue May 4, 2020 · 3 comments

Comments

@PaulRivier
Copy link

Hello,

first of all thank you for this impressive package.

I am using it for a project that involves natural language full text search. I must say that although the package quality seems absolutly brilliant, the documentation I found was a bit succinct. I would love to have a more comprehensive guide to leverage the full power of this package.

For example, I can not understand what is the point of transformQueryTerm :: Term -> field -> Term and how to make good use of it.

Thank you again, all the best

@bgamari
Copy link
Member

bgamari commented May 18, 2020

@dcoutts, ping.

@PaulRivier
Copy link
Author

Hi @bgamari, thank you for stepping in.

After some more investigations I managed to understand how to properly use transformQuery . Still, I think this package is really good and undervalued, and would greatly benefit from a more comprehensive documentation.

FWIW, I am using it on a new project named Kiwi , which aims to be a personal/small-team wiki based on plain files, and providing very good indexation capabilities. Full-text-search package does an excellent job on it.

Cheers

@bgamari
Copy link
Member

bgamari commented May 19, 2020

Hi @PaulRivier ,

No worries. If you feel so-compelled don't hesitate to open a small pull request adding documentation capturing you have learned. Otherwise I'm sure that either @dcoutts or I can look in due time.

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

2 participants