Skip to content

Commit 91b2479

Browse files
committed
Point user links to docs for "latest" version
The documentation hosted at arduino.github.io/arduino-cli is versioned, with the URL determining which version is loaded: - arduino.github.io/arduino-cli/0.20 - documentation content at the time of the latest release of the 0.20.x series - arduino.github.io/arduino-cli/latest - documentation content at the time of the latest release - arduino.github.io/arduino-cli/dev - documentation content at the tip of the default branch Previously, some of the links displayed to users by Arduino Lint were pointing at the "dev" version of that documentation. Since it may not apply to the release versions, or be in an unstable state, the "dev" version of the documentation should only be used by Arduino CLI developers and beta testers. For this reason, the "latest" version will be most appropriate for the users of Arduino Lint.
1 parent be98b2a commit 91b2479

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

internal/rule/ruleconfiguration/ruleconfiguration.go

+4-4
Original file line numberDiff line numberDiff line change
@@ -185,7 +185,7 @@ var configurations = []Type{
185185
Subcategory: "source code",
186186
ID: "LS008",
187187
Brief: "name-header mismatch",
188-
Description: "The match between the `library.properties` `name` field and the filename in an `#include` directive is a factor in the library's [dependency resolution priority](https://arduino.github.io/arduino-cli/dev/sketch-build-process/#dependency-resolution). It's recommended for the primary header filename to match the library name.",
188+
Description: "The match between the `library.properties` `name` field and the filename in an `#include` directive is a factor in the library's [dependency resolution priority](https://arduino.github.io/arduino-cli/latest/sketch-build-process/#dependency-resolution). It's recommended for the primary header filename to match the library name.",
189189
MessageTemplate: "No header file found matching library name ({{.}}). Best practices are for primary header filename to match library name.",
190190
Reference: "https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format",
191191
DisableModes: nil,
@@ -559,7 +559,7 @@ var configurations = []Type{
559559
Subcategory: "name field",
560560
ID: "LP018",
561561
Brief: "not in LM index",
562-
Description: "The library name (as defined by `name` field in [the `library.properties` metadata file](https://arduino.github.io/arduino-cli/dev/library-specification/#library-metadata)) was not found in the Library Manager index, but Arduino Lint was run in the [`--library-manager update` mode](https://arduino.github.io/arduino-lint/latest/commands/arduino-lint/#options), indicating that it was expected there.\n\nBecause the `name` value is the identifier used to install the library and define dependencies, it is not allowed to change after the library has been added to the index.",
562+
Description: "The library name (as defined by `name` field in [the `library.properties` metadata file](https://arduino.github.io/arduino-cli/latest/library-specification/#library-metadata)) was not found in the Library Manager index, but Arduino Lint was run in the [`--library-manager update` mode](https://arduino.github.io/arduino-lint/latest/commands/arduino-lint/#options), indicating that it was expected there.\n\nBecause the `name` value is the identifier used to install the library and define dependencies, it is not allowed to change after the library has been added to the index.",
563563
MessageTemplate: "Library name {{.}} not found in the Library Manager index. Library names are not allowed to change after being added to the index.",
564564
Reference: "https://github.com/arduino/library-registry/blob/main/FAQ.md#how-can-i-change-a-librarys-name",
565565
DisableModes: []rulemode.Type{rulemode.Default},
@@ -2907,7 +2907,7 @@ var configurations = []Type{
29072907
Brief: "upload.field.FIELD_NAME > max length",
29082908
Description: "The `tools.UPLOAD_RECIPE_ID.upload.field.FIELD_NAME` property in the platform's `platform.txt` configuration file is longer than the maximum length.",
29092909
MessageTemplate: "upload.UPLOAD_RECIPE_ID.upload.field.FIELD_NAME property is longer than the maximum length for fields: {{.}}",
2910-
Reference: "https://arduino.github.io/arduino-cli/dev/platform-specification/#user-provided-fields",
2910+
Reference: "https://arduino.github.io/arduino-cli/latest/platform-specification/#user-provided-fields",
29112911
DisableModes: nil,
29122912
EnableModes: []rulemode.Type{rulemode.Default},
29132913
InfoModes: nil,
@@ -2924,7 +2924,7 @@ var configurations = []Type{
29242924
Brief: "upload.field.FIELD_NAME.secret invalid",
29252925
Description: "The `tools.UPLOAD_RECIPE_ID.upload.field.FIELD_NAME.secret` property in the platform's `platform.txt` configuration file has an invalid value.",
29262926
MessageTemplate: "tools.UPLOAD_RECIPE_ID.upload.field.FIELD_NAME.secret value is invalid or field(s) {{.}}",
2927-
Reference: "https://arduino.github.io/arduino-cli/dev/platform-specification/#user-provided-fields",
2927+
Reference: "https://arduino.github.io/arduino-cli/latest/platform-specification/#user-provided-fields",
29282928
DisableModes: nil,
29292929
EnableModes: []rulemode.Type{rulemode.Default},
29302930
InfoModes: nil,

0 commit comments

Comments
 (0)