Skip to content
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

[skip changelog] Mention ArduinoCore-API in the "Cores" section of the platform specification #826

Merged
merged 1 commit into from
Jul 23, 2020
Merged

Conversation

per1234
Copy link
Contributor

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

ArduinoCore-API is an important resource for core authors, but they may not be aware of its existence. Aspiring platform authors are very likely to read the Arduino platform specification, but it contains no mention of ArduinoCore-API.

  • What is the new behavior?

The existence and purpose of ArduinoCore-API is mentioned in the "Cores" section of the Arduino platform specification.

  • Does this PR introduce a breaking change?

No.

@per1234 per1234 added the topic: documentation Related to documentation for the project label Jul 12, 2020
…ication

ArduinoCore-API is an important resource for core authors, so it is beneficial to alert the readers of this section of the Arduino platform specification to its existence.
@rsora rsora merged commit c95810c into arduino:master Jul 23, 2020
@per1234 per1234 deleted the arduinocore-api branch July 23, 2020 12:44
@per1234 per1234 assigned per1234 and unassigned per1234 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