Minimal code comments limited to the essentials would be beneficial
Opened this issue · 0 comments
schittli commented
Good evening
Thank you very much for sharing your great work!
It is a pity that the project does not have even minimal documentation in the form of small code comments focused on the essentials:
You are programming this great library to be used. Still, without minimal Doc probably 9 out of 10 interested parties are likely to discard Catalyst after a few hours of try & error.
Describe the solution you'd like
Code comments should offer basic information. Here are just some examples:
LanguageDetector.FromStoreAsync()
: Why does it only accept one Language as a parameter and not an array?LanguageDetector.FromStoreAsync()
: What is this Store? Online? Local? Is it automatically downloading / updating a local cache? Do we need to download the nuget language models?PartOfSpeech.cs
: What is the idea behind PartOfSpeech?- …
Thanks a lot, kind regards,
Thomas