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

Docs: clarify difference between "DEFAULT_LANGUAGES" and "languages" settings #1218

Open
keikoro opened this issue Feb 9, 2024 · 0 comments

Comments

@keikoro
Copy link

keikoro commented Feb 9, 2024

It would be helpful if the section on Default Languages in the docs made it clearer that DEFAULT_LANGUAGES is an additional setting and should not be confused with the main languages setting when parsing dates.

I don't entirely understand what it's meant to be used for anyway; more detailed explanation i.e. better documentation may help reduce the likelihood of them getting confused.

User (experience) story: I'm a new user to the library who perused the "Settings" section after skimming the introduction due to the particular problem I'm trying to solve. I ended up confusing the DEFAULT_LANGUAGES setting with languages – the two basically melded in my brain, likely helped by the fact they use identical formatting – and I consequently spent/wasted time debugging a problem (language-specific date formatting being outright ignored) that actually wasn't one.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant