Skip to content

Commit 484ccbd

Browse files
committed
Target sketch specification reference links to appropriate section
The Arduino Sketch Specification document has had some recent changes to avoid ambiguity. This allows the reference links to now point to the specific section of the specification relevant to that rule so that the user will be able to find the information quickly.
1 parent 91b2479 commit 484ccbd

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

internal/rule/ruleconfiguration/ruleconfiguration.go

+3-3
Original file line numberDiff line numberDiff line change
@@ -1377,7 +1377,7 @@ var configurations = []Type{
13771377
Brief: "prohibited character in filename",
13781378
Description: "A sketch file's name contains a prohibited character.",
13791379
MessageTemplate: "Prohibited character(s) in file name(s): {{.}}",
1380-
Reference: "https://arduino.github.io/arduino-cli/latest/sketch-specification/#sketch-root-folder",
1380+
Reference: "https://arduino.github.io/arduino-cli/latest/sketch-specification/#sketch-folders-and-files",
13811381
DisableModes: nil,
13821382
EnableModes: []rulemode.Type{rulemode.Default},
13831383
InfoModes: nil,
@@ -1394,7 +1394,7 @@ var configurations = []Type{
13941394
Brief: "file name too long",
13951395
Description: "The sketch file's name exceeds the maximum length.",
13961396
MessageTemplate: "File name(s): {{.}} exceed maximum length.",
1397-
Reference: "https://arduino.github.io/arduino-cli/latest/sketch-specification/#sketch-root-folder",
1397+
Reference: "https://arduino.github.io/arduino-cli/latest/sketch-specification/#sketch-folders-and-files",
13981398
DisableModes: nil,
13991399
EnableModes: []rulemode.Type{rulemode.Default},
14001400
InfoModes: nil,
@@ -1411,7 +1411,7 @@ var configurations = []Type{
14111411
Brief: ".pde extension",
14121412
Description: "A sketch file uses the deprecated `.pde` file extension. The .pde extension is used by both [Processing](https://processing.org/) sketches and Arduino sketches. If the project has supplemental Processing sketches, they should either be in the [`data` subfolder of the sketch](https://arduino.github.io/arduino-cli/latest/sketch-specification/#data-subfolder) or in the [`extras` folder of the library](https://arduino.github.io/arduino-cli/latest/library-specification/#extra-documentation). Arduino sketches should use the modern `.ino` extension.",
14131413
MessageTemplate: "{{.}} uses deprecated .pde file extension. Use .ino for Arduino sketches.",
1414-
Reference: "https://arduino.github.io/arduino-cli/latest/sketch-specification",
1414+
Reference: "https://arduino.github.io/arduino-cli/latest/sketch-specification/#additional-code-files",
14151415
DisableModes: nil,
14161416
EnableModes: []rulemode.Type{rulemode.Default},
14171417
InfoModes: nil,

0 commit comments

Comments
 (0)