Skip to content

[skip changelog] Make library location priority documentation more relevant to Arduino CLI #732

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
Jun 10, 2020
Merged

[skip changelog] Make library location priority documentation more relevant to Arduino CLI #732

merged 1 commit into from
Jun 10, 2020

Conversation

per1234
Copy link
Contributor

@per1234 per1234 commented May 31, 2020

Please check if the PR fulfills these requirements

  • The PR has no duplicates (please search among the Pull Requests before creating one)
  • The PR follows our contributing guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)
  • What kind of change does this PR introduce?

Make the library dependency resolution location priority section of the sketch build process documentation more relevant to Arduino CLI.

  • What is the current behavior?

This section of the documentation was written with a focus on the Arduino IDE, and thus was not very friendly to Arduino CLI users.

  • What is the new behavior?

The documentation is more relevant to the Arduino CLI.

  • Does this PR introduce a breaking change?

No.

@itsayellow I welcome your feedback on this change.

…levant to Arduino CLI

This section of the documentation was written with a focus on the Arduino IDE, and thus was not very friendly to Arduino CLI users.
@itsayellow
Copy link

Thank you for this PR!

I'm wondering if you could document also how to find Arduino CLI's user directory. It wasn't obvious to me that you find that by executing arduino-cli config dump and then looking at directories:, user. (And I really tried to figure out where arduino-cli thought of as home base.)

@per1234
Copy link
Contributor Author

per1234 commented May 31, 2020

I'm wondering if you could document also how to find Arduino CLI's user directory.

I do have this on my "to do" list, but it's not yet clear in my mind what is the best way to do it.

Since that work is only very loosely related to the change made in this PR, it's more appropriate for it to be done in a separate PR.

@itsayellow
Copy link

Ok, then I like this PR, it helps clarify very well!

@per1234 per1234 added the topic: documentation Related to documentation for the project label May 31, 2020
Copy link
Contributor

@rsora rsora left a comment

Choose a reason for hiding this comment

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

🔎 📖

@rsora rsora merged commit d3f2dec into arduino:master Jun 10, 2020
@per1234 per1234 deleted the improve-library-path-documentation branch June 11, 2020 10:21
umbynos pushed a commit that referenced this pull request Jun 17, 2020
…levant to Arduino CLI (#732)

This section of the documentation was written with a focus on the Arduino IDE, and thus was not very friendly to Arduino CLI users.
@per1234 per1234 self-assigned this Nov 23, 2021
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants