add possible errors on API docs
kazupon opened this issue · comments
reference
vue-i18n API documentation does not mention that an error is raised if an unexpected ?>value is specified.
https://vue-i18n.intlify.dev/api/composition.html#composernumberformatting
I think it would help to mention it in the documentation.
Originally posted by @kazupon in #1746 (comment)
summary
The vue-i18n API functions do not describe the errors that can occur.
We need to pick up the provided API and include it in the docs.
The API docs are generated from the source code and should be written in tsdoc (jsdoc) format.
Hello, is this issue open. I would like to give it a try.
Hello! I'm interested in contributing to this issue. I've reviewed the problem description and believe I can help add information about potential errors in the vue-i18n API documentation. Could I please be assigned to this issue? Looking forward to contributing! Thank you!
@sharsha315 @bagenigilbert
Feel free to open a PR with the changes you would like to make!
There's no need to get approval or get assigned to the issue (especially so for issues marked good first issue), it's a community driven project and I'm sure all contributions are greatly appreciated 🙏