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

locale is included in the sample config but not the documentation #3654

Open
mmclane opened this issue Dec 13, 2024 · 5 comments
Open

locale is included in the sample config but not the documentation #3654

mmclane opened this issue Dec 13, 2024 · 5 comments

Comments

@mmclane
Copy link

mmclane commented Dec 13, 2024

Hello and thank you for opening an issue.

I found a bug in MagicMirror

Please make sure to only submit reproducible issues. You can safely remove everything above the dividing line.
When submitting a new issue, please supply the following information:

Platform: Place your platform here... give us your web browser/Electron version and your hardware (Raspberry Pi 2/3/4, Windows, Mac, Linux, System V UNIX).

NA

Node Version: Make sure it's version 18 or later (recommended is 20).

NA

MagicMirror² Version: Please let us know which version of MagicMirror² you are running. It can be found in the package.json file.

v2.29.0

Description: Provide a detailed description about the issue and include specific details to help us understand the problem. Adding screenshots will help describing the problem.

I am setting up MM for the first time. I was going through the sample config that I got here: https://github.com/MagicMirrorOrg/MagicMirror/blob/master/config/config.js.sample

It has a setting for locale. That configuration option isn't included in the documentation here: https://docs.magicmirror.builders/configuration/introduction.html

I don't know what it does or how it should be configured.

Steps to Reproduce: List the step by step process to reproduce the issue.

See provided URLS

Expected Results: Describe what you expected to see.

The documentation includes locale and I know what to do with it.

Actual Results: Describe what you actually saw.

NA

Configuration: What does the used config.js file look like? Don't forget to remove any sensitive information!

NA

Additional Notes: Provide any other relevant notes not previously mentioned. This is optional.

@sdetweil
Copy link
Collaborator

thats cause we don't use it.. it was added in early 2021 for use by third party modules

#2461

@rejas
Copy link
Collaborator

rejas commented Dec 14, 2024

So maybe it would make sense to update the docs with this info?

@sdetweil
Copy link
Collaborator

sdetweil commented Dec 14, 2024

i started down that path, but then realized i dont know what should be there or a good reference

i would add it to mmm-config as a selection list maybe

@khassel
Copy link
Collaborator

khassel commented Dec 14, 2024

I think it is sufficient to add a comment in the config sample file that this property is only added for use by third party modules and is not used in mm core (and default modules)

@sdetweil
Copy link
Collaborator

opened pr #3655

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

No branches or pull requests

4 participants