kazupon/vue-i18n

`availableLocales` option is wrong docs

Open

#1528 opened on Jul 15, 2022

View on GitHub
 (0 comments) (0 reactions) (0 assignees)JavaScript (7,181 stars) (886 forks)batch import
Status: PR WelcomeType: Documentationgood first issue

Description

docs say availableLocales can be passed to the constructor option. That is incorrect documentation We need to fix it.

Originally posted by @kazupon in https://github.com/kazupon/vue-i18n/issues/1523#issuecomment-1185475275

Contributor guide

Tech stack
javascriptvue
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90
Research direction
The issue states that the `availableLocales` option is incorrectly documented as a constructor option. Look at the Vue I18n documentation source, likely in the `docs/` directory, to find and correct the description. The fix is to remove or update the mention of `availableLocales` in the constructor options, possibly in a file like `docs/guide/options.md` or similar. No further investigation is needed as the required change is clearly specified.