Skip to content

[doc] locale is missing from the CLI config spec #1928

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

Closed
3 tasks done
kittaakos opened this issue Oct 18, 2022 · 1 comment · Fixed by #1952
Closed
3 tasks done

[doc] locale is missing from the CLI config spec #1928

kittaakos opened this issue Oct 18, 2022 · 1 comment · Fixed by #1952
Labels
conclusion: resolved Issue was resolved topic: documentation Related to documentation for the project type: imperfection Perceived defect in any part of project

Comments

@kittaakos
Copy link
Contributor

Describe the problem

locale is a valid CLI config entry, but it's undocumented yet. https://arduino.github.io/arduino-cli/0.27/configuration/#configuration-keys

To reproduce

Go to https://arduino.github.io/arduino-cli/0.27/configuration/#configuration-keys, locale is not there.

Expected behavior

locale is documented

Arduino CLI version

It's not a CLI malfunction

Operating system

macOS

Operating system version

12.5.1

Additional context

No response

Issue checklist

  • I searched for previous reports in the issue tracker
  • I verified the problem still occurs when using the nightly build
  • My report contains all necessary details
@kittaakos kittaakos added topic: documentation Related to documentation for the project type: imperfection Perceived defect in any part of project labels Oct 18, 2022
@per1234
Copy link
Contributor

per1234 commented Oct 18, 2022

Beyond a documentation deficiency, the configuration key is not even supported by the arduino-cli config command:

$ arduino-cli version
arduino-cli.exe  Version: git-snapshot Commit: 54a0bc07 Date: 2022-10-18T10:28:55Z

$ arduino-cli config set locale de
Settings key doesn't exist

I think that bug should be fixed before or during the documentation update since the user will expect to have full functionality from any documented configuration key.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
conclusion: resolved Issue was resolved topic: documentation Related to documentation for the project type: imperfection Perceived defect in any part of project
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants