Skip to content

Commit 719f5b9

Browse files
ianfixesikatz-drizly
authored andcommitted
Improve clarity of library.properties include= field
The existing wording doesn't convey the fact that, despite literal reference to `#include`, this setting isn't a directive to the compiler. The updated text makes it more clear that the setting drives a convenience function in the IDE, where text is added to the sketch currently being edited.
1 parent 6a177eb commit 719f5b9

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

docs/library-specification.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -79,9 +79,10 @@ otherwise below, **all fields are required**. The available fields are:
7979
<!-- prettier-ignore -->
8080
files in the linker command directly, all .o files are saved into a .a file, which is then included in the linker
8181
command. [1.5 format library folder structure](#layout-of-folders-and-files) is required.
82-
- **includes** - **(available from Arduino IDE 1.6.10)** (optional) a comma separated list of files to be added to the
83-
sketch as `#include <...>` lines. This property is used with the "Include library" command in the Arduino IDE. If the
84-
`includes` property is missing, all the header files (.h) on the root source folder are included.
82+
- **includes** - **(available from Arduino IDE 1.6.10)** (optional) a comma separated list, indicating the set of files
83+
that a sketch would need to include (as `#include <...>` lines) in order to use the library. This property informs the
84+
"Include library" command in the Arduino IDE, which auto-inserts those lines into a sketch. If the `includes` property
85+
is missing, all the header files (.h) on the root source folder are inserted.
8586
- **precompiled** - **(available from Arduino IDE 1.8.6/arduino-builder 1.4.0)** (optional) enables support for .a
8687
(archive) and .so (shared object) files. See the ["Precompiled binaries"](#precompiled-binaries) section for
8788
documentation of the required location in the library for these files. The static library should be linked as an

0 commit comments

Comments
 (0)