terryyin/translate-python

Confusing documentation on translation providers

Opened this issue · 0 comments

The current documentation (2022-01-12) is a bit confusing for what concerns the providers, at least in the section describing the Python module.

At https://pypi.org/project/translate/:

  • subsection "Use a different translation provider": different from which one? The default provider is never defined.
    • in the same subsection: translator = Translator(provider='<the name of the provider, eg. microsoft or deepl>', to_lang=to_lang, secret_access_key=secret), but those two names (microsoft,deepl) are different from those in the readthedocs pages.

At https://translate-python.readthedocs.io/en/latest/:

  • the Microsoft provider seems to be named MicrosoftProvider , different from the microsoft above
  • the DeepL provider does not appear in the section "Providers"

The ambiguities in the pypi pages are found also in the "Tutorial" section on readthedocs.io: https://translate-python.readthedocs.io/en/latest/tutorial.html, where the Microsoft provider is named "microsoft". In the tutorial, the provider DeepL is not present.