Skip to content

Commit 3306750

Browse files
authored
[skip changelog] Correct library+sketch specifications re: spaces in folder name (#1194)
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.
1 parent 3324298 commit 3306750

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

Diff for: docs/library-specification.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ may be added as needed to future revisions.
121121
#### Library Root folder
122122

123123
The library root folder name must start with a basic letter (A-Z or a-z) or number (0-9), followed by basic letters,
124-
numbers, spaces ( ), underscores (\_), dots (.) and dashes (-). The maximum length is 63 characters.
124+
numbers, underscores (\_), dots (.) and dashes (-). The maximum length is 63 characters.
125125

126126
#### Source code
127127

Diff for: docs/sketch-specification.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ Because many Arduino sketches only contain a single .ino file, it's easy to thin
1111
it is the folder that is the sketch. The reason is that sketches may consist of multiple code files and the folder is
1212
what groups those files into a single program.
1313

14-
<!-- prettier-ignore -->
15-
The sketch root folder name must start with a basic letter (`A`-`Z` or `a`-`z`) or number (`0`-`9`), followed by basic letters, numbers, spaces (` `), underscores (`_`), dots (`.`) and dashes (`-`). The maximum length is 63 characters.
14+
The sketch root folder name must start with a basic letter (`A`-`Z` or `a`-`z`) or number (`0`-`9`), followed by basic
15+
letters, numbers, underscores (`_`), dots (`.`) and dashes (`-`). The maximum length is 63 characters.
1616

1717
Support for sketch folder names starting with a number was added in Arduino IDE 1.8.4.
1818

0 commit comments

Comments
 (0)