Skip to content

Commit ad5d941

Browse files
cmaglieper1234
andcommitted
Improved docs
Co-authored-by: Per Tillisch <[email protected]>
1 parent 8b4b3a5 commit ad5d941

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

docs/sketch-project-file.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -59,12 +59,12 @@ otherwise below). The available fields are:
5959
- `libraries:` is a section where the required libraries to build the project are defined. This section is optional.
6060
- `<INDEX_LIB_NAME> (<INDEX_LIB_VERSION>)` represents a library from the Arduino Libraries Index that is a direct
6161
dependency of the sketch, for example, `MyLib (1.0.0)`.
62-
- `dependency: <INDEX_LIB_NAME> (<INDEX_LIB_VERSION>)` represents a library from the Arduino Libraries Index that is
63-
an "indirect dependency", i.e., a library that is not used directly by the sketch, but is required by other
64-
libraries used by the sketch. For example, if `LibUsedInSketch` requires `UtilLib`, this information can be recorded
65-
in the profile with the declaration `dependency: UtilLib (1.3.4)`. During sketch compilation, a dependency library
66-
is treated the same as a non-dependency library; the only difference is in automatic library management, where a
67-
dependency library can be installed or removed together with the library that uses it.
62+
- `dependency: <INDEX_LIB_NAME> (<INDEX_LIB_VERSION>)` represents a library from the Arduino Libraries Index that is a
63+
"transitive dependency", i.e., a library that is not used directly by the sketch, but is required by other libraries
64+
used by the sketch. For example, if `LibUsedInSketch` requires `UtilLib`, this information can be recorded in the
65+
profile with the declaration `dependency: UtilLib (1.3.4)`. During sketch compilation, a `dependency` library is
66+
treated the same as a non-`dependency` library; the only difference is in automatic library management, where a
67+
`dependency` library can be installed or removed together with the library that uses it.
6868
- `dir: <LOCAL_LIB_PATH>` represents a library installed in the filesystem and `<LOCAL_LIB_PATH>` is the path to the
6969
library. The path could be absolute or relative to the sketch folder. This option is available since Arduino CLI
7070
1.3.0.

0 commit comments

Comments
 (0)