chrislit/abydos

Documentation on usage including simple use cases

Opened this issue · 1 comments

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.)

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