Skip to content

[skip changelog] Correct configuration key name in documentation #2903

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

Merged
merged 1 commit into from
May 2, 2025

Conversation

per1234
Copy link
Contributor

@per1234 per1234 commented May 1, 2025

Please check if the PR fulfills these requirements

See how to contribute

  • The PR has no duplicates (please search among the Pull Requests
    before creating one)
  • The PR follows
    our contributing guidelines
  • [N/A] Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)
  • [N/A] UPGRADING.md has been updated with a migration guide (for breaking changes)
  • [N/A] configuration.schema.json updated if new parameters are added.

What kind of change does this PR introduce?

Docs update

What is the current behavior?

A reference to Arduino CLI's directories.downloads configuration key in the documentation is misspelled as "directories.download".

What is the new behavior?

The configuration key name is correctly spelled.

Does this PR introduce a breaking change, and is titled accordingly?

No breaking change

Other information

Originally reported at https://forum.arduino.cc/t/configuration-file/1378100/7

@per1234 per1234 added topic: documentation Related to documentation for the project type: imperfection Perceived defect in any part of project labels May 1, 2025
@per1234 per1234 requested a review from alessio-perugini May 1, 2025 05:39
@per1234 per1234 self-assigned this May 1, 2025
Previously, this reference to Arduino CLI's `directories.downloads` configuration key misspelled the name as
"directories.download".
@per1234 per1234 force-pushed the correct-config-key branch from 5f261a0 to 77dd206 Compare May 1, 2025 05:54
Copy link
Contributor

@alessio-perugini alessio-perugini left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@alessio-perugini alessio-perugini merged commit 3929052 into arduino:master May 2, 2025
6 checks passed
@per1234 per1234 deleted the correct-config-key branch May 2, 2025 08:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: documentation Related to documentation for the project type: imperfection Perceived defect in any part of project
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants