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 on usage including simple use cases #260

Open
mcarans opened this issue May 15, 2020 · 1 comment
Open

Documentation on usage including simple use cases #260

mcarans opened this issue May 15, 2020 · 1 comment

Comments

@mcarans
Copy link

mcarans commented May 15, 2020

This library has an impressive number of algorithms, but there doesn't seem to be any documentation of how to use them together. For example given a test word, test_word, and a list of candidates, candidate_list, how can I see which word in candidate_list matches most closely to test_word with various phonetic and distance algorithms?

(Compare with the README for this library where it seems quite simple: https://github.com/Lilykos/pyphonetics. However that library has far fewer algorithms.)

@abubelinha
Copy link

abubelinha commented Nov 20, 2021

I was also looking for examples on how to import and use the library.
Here I found some clues.
But I agree there should be some very basic examples in the documentation intro or faqs

@abubelinha

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