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

add possible errors on API docs #1749

Open
kazupon opened this issue Feb 28, 2024 · 3 comments
Open

add possible errors on API docs #1749

kazupon opened this issue Feb 28, 2024 · 3 comments
Labels
good first issue Good for newcomers help wanted Extra attention is needed 🍰 p2-nice-to-have Priority 2: nothing is broken but it's worth addressing Status: PR Welcome Welcome to Pull Request Type: Documentation A documetation fixes

Comments

@kazupon
Copy link
Member

kazupon commented Feb 28, 2024

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.

@kazupon kazupon added good first issue Good for newcomers help wanted Extra attention is needed Status: PR Welcome Welcome to Pull Request Type: Documentation A documetation fixes 🍰 p2-nice-to-have Priority 2: nothing is broken but it's worth addressing labels Feb 28, 2024
@sharsha315
Copy link

Hello, is this issue open. I would like to give it a try.

@bagenigilbert
Copy link

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!

@BobbieGoede
Copy link
Contributor

@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 🙏

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers help wanted Extra attention is needed 🍰 p2-nice-to-have Priority 2: nothing is broken but it's worth addressing Status: PR Welcome Welcome to Pull Request Type: Documentation A documetation fixes
Projects
None yet
Development

No branches or pull requests

4 participants