Skip to content

[skip changelog] Document library.properties precompiled field's "full" option #829

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
Jul 23, 2020
Merged

[skip changelog] Document library.properties precompiled field's "full" option #829

merged 1 commit into from
Jul 23, 2020

Conversation

per1234
Copy link
Contributor

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

Previously, the precompiled field of library.properties only supported one value: true. As it became apparent that there were two distinct use cases for this feature (arduino/arduino-builder#353), it was necessary to add a new full option so that both use cases could be fully supported (#611). However, the full option is not documented.

  • What is the new behavior?

The precompiled field of library.properties' full value is documented in the appropriate section of the Arduino library specification.

  • Does this PR introduce a breaking change?

No.

  • Other information:

The undocumented nature of this option was noted in #754

@per1234 per1234 added the topic: documentation Related to documentation for the project label Jul 13, 2020
Previously, the precompiled field of library.properties only supported one value: "true". As it became apparent that there were two distinct use cases for this feature, it was necessary to add a new option so that both use cases could be fully supported.
@rsora rsora merged commit 99c646b into arduino:master Jul 23, 2020
@per1234 per1234 deleted the precompiled-full-value branch July 23, 2020 12:44
@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