[skip changelog] Correct library+sketch specifications re: spaces in folder name #1194
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
…folder name The previous mention of spaces as one of the characters allowed in library and sketch folder names was a copy/paste error originating in the allowed characters in library.properties `name` properties. This specific part of the `name` property specification doesn't apply to folder names. The reason it is allowed in the `name` property is because that value is "sanitized" before being used by Library Manager for the library installation folder name by replacing all spaces with underscores.
per1234
changed the title
5 tasks
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 library and sketch specifications say that spaces are allowed in library and sketch folder names, but this is not supported by the Arduino IDE. Use of spaces in the folder name will result in a warning on IDE startup and the project not being recognized.
The previous mention of spaces as one of the characters allowed in library and sketch folder names was a copy/paste
error originating in the allowed characters in library.properties
nameproperties. This specific part of thenameproperty specification doesn't apply to folder names. The reason it is allowed in the
nameproperty is because thatvalue is "sanitized" before being used by Library Manager for the library installation folder name by replacing all
spaces with underscores.
The erroneous mention of spaces as one of the allowed characters for library and sketch folder names is removed.
titled accordingly?
No
It was previously necessary to disable Prettier formatting of the sentence in question in the sketch specification:
The reason for this was that prettier removed the space from between the backticks in that sentence. Now that the space has been removed from the sentence, it can be safely formatted by Prettier.
See how to contribute