From 9b5f8d3ff84cba7f418beb65ddec50b786e7b0fd Mon Sep 17 00:00:00 2001 From: per1234 Date: Tue, 23 Feb 2021 23:30:11 -0800 Subject: [PATCH] [skip changelog] Correct library+sketch specifications re: spaces in 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. --- docs/library-specification.md | 2 +- docs/sketch-specification.md | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/library-specification.md b/docs/library-specification.md index bdbc9ccdb2d..09837e53722 100644 --- a/docs/library-specification.md +++ b/docs/library-specification.md @@ -121,7 +121,7 @@ may be added as needed to future revisions. #### Library Root folder The library 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. +numbers, underscores (\_), dots (.) and dashes (-). The maximum length is 63 characters. #### Source code diff --git a/docs/sketch-specification.md b/docs/sketch-specification.md index f1f2dd9c292..374814e6ec2 100644 --- a/docs/sketch-specification.md +++ b/docs/sketch-specification.md @@ -11,8 +11,8 @@ Because many Arduino sketches only contain a single .ino file, it's easy to thin it is the folder that is the sketch. The reason is that sketches may consist of multiple code files and the folder is what groups those files into a single program. - -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. +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, underscores (`_`), dots (`.`) and dashes (`-`). The maximum length is 63 characters. Support for sketch folder names starting with a number was added in Arduino IDE 1.8.4.