Skip to content

Commit 3e0b63c

Browse files
committed
Apply suggestions from code review
1 parent 9801805 commit 3e0b63c

File tree

3 files changed

+6
-4
lines changed

3 files changed

+6
-4
lines changed

Diff for: docs/sketch-profiles.md renamed to docs/sketch-project-file.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,8 @@ profiles:
3333
...more profiles here...
3434
```
3535

36-
There is an optional `profiles:` section containing all the profiles. Each field in a profile is mandatory (unless noted otherwise below). The available fields are:
36+
There is an optional `profiles:` section containing all the profiles. Each field in a profile is mandatory (unless noted
37+
otherwise below). The available fields are:
3738

3839
- `<PROFILE_NAME>` is the profile identifier, it’s a user-defined field, and the allowed characters are alphanumerics,
3940
underscore `_`, dot `.`, and dash `-`.
@@ -42,8 +43,8 @@ There is an optional `profiles:` section containing all the profiles. Each field
4243
- `<3RD_PARTY_PLATFORM_URL>` is the index URL to download the target core platform (also known as “Additional Boards
4344
Manager URLs” in the Arduino IDE). This field can be omitted for the official `arduino:*` platforms.
4445
- `<PLATFORM_DEPENDENCY>`, `<PLATFORM_DEPENDENCY_VERSION>`, and `<3RD_PARTY_PLATFORM_DEPENDENCY_URL>` contains the same
45-
information as `<PLATFORM>`, `<PLATFORM_VERSION>`, and `<3RD_PARTY_PLATFORM_URL>` respectively but for the core platform dependency
46-
of the main core platform. These fields are optional.
46+
information as `<PLATFORM>`, `<PLATFORM_VERSION>`, and `<3RD_PARTY_PLATFORM_URL>` respectively but for the core
47+
platform dependency of the main core platform. These fields are optional.
4748
- `libraries:` is a section where the required libraries to build the project are defined. This section is optional.
4849
- `<LIB_VERSION>` is the version required for the library, for example, `1.0.0`.
4950
- `<USER_NOTES>` is a free text string available to the developer to add comments.

Diff for: docs/sketch-specification.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ needed to build the sketch (platform and libraries each pinned to a specific ver
8989
When using a profile to compile, Arduino CLI will install all the required resources in a isolated environment, used
9090
only for the build, leaving the libraries and platforms installed globally in the system untouched.
9191

92-
For more information see the [profiles documentation](sketch-profiles.md).
92+
For more information see the [sketch project file](sketch-project-file.md) documentation.
9393

9494
### Secrets
9595

Diff for: mkdocs.yml

+1
Original file line numberDiff line numberDiff line change
@@ -107,6 +107,7 @@ nav:
107107
- Integration options: integration-options.md
108108
- sketch-build-process.md
109109
- sketch-specification.md
110+
- sketch-project-file.md
110111
- library-specification.md
111112
- platform-specification.md
112113
- Pluggable discovery specification: pluggable-discovery-specification.md

0 commit comments

Comments
 (0)