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

Minimal code comments limited to the essentials would be beneficial #86

Open
schittli opened this issue Jan 22, 2023 · 0 comments
Open

Comments

@schittli
Copy link

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

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

1 participant