[skip changelog] Document sketch filename requirements #1287
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Previously, the Arduino Sketch Specification only documented the requirements for sketch folder names. Since the primary sketch filename must match the folder name, this appeared at a glance to be self-evident. However, sketches may consist of multiple files, and so the specification was ambiguous regarding the naming requirements for additional files.
per1234
added
type: bug
topic: documentation
silvanocerza
approved these changes
May 12, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Please check if the PR fulfills these requirements
before creating one)
our contributing guidelines
UPGRADING.mdhas been updated with a migration guide (for breaking changes)docs update
The Arduino Sketch Specification only documents the requirements for sketch folder names. Since the primary sketch filename must match the folder name, this appears at a glance to be self-evident. However, sketches may consist of multiple code files, and so the specification was ambiguous regarding the naming requirements for additional files.
The specification documents that the same naming requirements apply to all sketch code files.
titled accordingly?
No breaking change.
Related: #1194
See how to contribute