Skip to content

Commit d4b2e56

Browse files
committed
Rename checkconfigurations.Type.Name field to checkconfigurations.Type.Brief
"Name" seemed to give the wrong impression of the purpose of this field.
1 parent 67b3f35 commit d4b2e56

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

check/checkconfigurations/checkconfigurations.go

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ type Type struct {
2121
Category string
2222
Subcategory string
2323
ID string // Unique check identifier: <project type identifier (L|S|P|I)><category identifier><number>
24-
Name string // Short description of the check.
24+
Brief string // Short description of the check.
2525
Description string // Supplemental information about the check.
2626
MessageTemplate string // The warning/error message template displayed when the check fails. Will be filled by check function output.
2727
// The following fields define under which tool configuration modes the check will run:
@@ -41,7 +41,7 @@ var Configurations = []Type{
4141
Category: "library.properties",
4242
Subcategory: "general",
4343
ID: "LP001",
44-
Name: "invalid format",
44+
Brief: "invalid format",
4545
Description: "",
4646
MessageTemplate: "library.properties has an invalid format: {{.}}",
4747
DisableModes: nil,
@@ -56,7 +56,7 @@ var Configurations = []Type{
5656
Category: "library.properties",
5757
Subcategory: "name field",
5858
ID: "LP002",
59-
Name: "missing name field",
59+
Brief: "missing name field",
6060
Description: "",
6161
MessageTemplate: "missing name field in library.properties",
6262
DisableModes: nil,
@@ -71,7 +71,7 @@ var Configurations = []Type{
7171
Category: "library.properties",
7272
Subcategory: "name field",
7373
ID: "LP003",
74-
Name: "disallowed characters",
74+
Brief: "disallowed characters",
7575
Description: "",
7676
MessageTemplate: "disallowed characters in library.properties name field. See: https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format",
7777
DisableModes: nil,
@@ -86,7 +86,7 @@ var Configurations = []Type{
8686
Category: "library.properties",
8787
Subcategory: "version field",
8888
ID: "LP004",
89-
Name: "missing version field",
89+
Brief: "missing version field",
9090
Description: "",
9191
MessageTemplate: "missing version field in library.properties",
9292
DisableModes: nil,
@@ -101,7 +101,7 @@ var Configurations = []Type{
101101
Category: "structure",
102102
Subcategory: "",
103103
ID: "SS001",
104-
Name: ".pde extension",
104+
Brief: ".pde extension",
105105
Description: "The .pde extension is used by both Processing sketches and Arduino sketches. Processing sketches should either be in the \"data\" subfolder of the sketch or in the \"extras\" folder of the library. Arduino sketches should use the modern .ino extension",
106106
MessageTemplate: "{{.}} uses deprecated .pde file extension. Use .ino for Arduino sketches",
107107
DisableModes: nil,

0 commit comments

Comments
 (0)