search

well-typed / full-text-search

An in-memory full text search engine library. It lets you run full-text queries on a collection of your documents.
Other
47 stars 5 forks source link

Documentation request #3

Open PaulRivier opened 4 years ago

PaulRivier commented 4 years ago

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 commented 4 years ago

@dcoutts, ping.

PaulRivier commented 4 years ago

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 commented 4 years ago

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.