Skip to content

[skip changelog] Update library specification to reflect recently added features #789

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
Jul 6, 2020
Merged

[skip changelog] Update library specification to reflect recently added features #789

merged 2 commits into from
Jul 6, 2020

Conversation

per1234
Copy link
Contributor

@per1234 per1234 commented Jul 5, 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?

Docs update

  • What is the current behavior?

The Library specification contains some outdated statements:

  • Claim that Library Manager doesn't handle dependencies of libraries, which is no longer true.
  • Statement reflecting previously non-configurable nature of the development software's "include library" feature.
  • What is the new behavior?

Outdated statements in library specification are removed or updated.

  • Does this PR introduce a breaking change?

No.

per1234 added 2 commits July 5, 2020 00:57
@per1234
[skip ci] Remove outdated statement re: Library Manager not handling …
3d00af8 
…library dependencies

Dependencies of libraries may now be defined via the depends field of library.properties and Library Manager will automatically install these dependencies when the library is installed.

This is well documented later in the specification, so there is no need to mention it in the Library Manager overview.
@per1234
[skip ci] Update documentation re: library "import" behavior
20be188 
The described behavior is now configurable via the includes field of library.properties.
@per1234 per1234 added the topic: documentation Related to documentation for the project label Jul 5, 2020
@rsora rsora requested a review from cmaglie July 6, 2020 14:28
@per1234 per1234 merged commit 0b457a9 into arduino:master Jul 6, 2020
@per1234 per1234 deleted the update-library-specification branch July 6, 2020 17:22
@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
Reviewers

@cmaglie cmaglie cmaglie approved these changes

Assignees

@per1234 per1234

Labels
topic: documentation Related to documentation for the project
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@per1234 @cmaglie