Poor builtin documentation (no JSDoc, including in TypeScript declaration files (index.d.ts))

[Chealer]

Documentation issue

The definition files of react-i18next are minimal, providing little (if any) documentation of the functions and interfaces they define. For example, as of 15.0.1, index.d.ts does not document its purpose, let alone what it returns. That is pretty well documented in the online documentation, but there is not even a link to that from the "header files".

Motivation

Make it easier to understand how applications using react-i18next are implemented.

[adrai]

Our documentation is the online documentation... we usually don't document in the type definition files, since i18next is a JavaScript and not a TypeScript project... but if you want, you can for sure provide a PR to extend the type definition files.

[Chealer]

Our documentation is the online documentation... we usually don't document in the type definition files, since i18next is a JavaScript and not a TypeScript project...

That's basically what this reports, yes. I see your point, but TypeScript bindings can be generated from JavaScript. Judging from src/useTranslation.js, the problem is that react-i18next has no JSDoc.

but if you want, you can for sure provide a PR to extend the type definition files.

Thanks, but provide what?

[stale[bot]]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

[Chealer]

@stale: what do you mean by marking "as stale" and closing this issue?