Skip to content

Commit 5526f51

Browse files
per1234per1234
committed
Improve wording of rule messages
1 parent d4c5e9c commit 5526f51

File tree

1 file changed

+24
-24
lines changed

1 file changed

+24
-24
lines changed

‎internal/rule/ruleconfiguration/ruleconfiguration.go

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ var configurations = []Type{
129129
ID: "LS005",
130130
Brief: "symlink",
131131
Description: "",
132-
MessageTemplate: "Symlink(s) found at {{.}}. Symlinks cause difficulties for Windows users. These block acceptance to the Arduino Library Manager index.",
132+
MessageTemplate: "Symlink(s) found at {{.}}. Symlinks cause difficulties for Windows users. These block addition to the Arduino Library Manager index.",
133133
DisableModes: nil,
134134
EnableModes: []rulemode.Type{rulemode.Default},
135135
InfoModes: nil,
@@ -161,7 +161,7 @@ var configurations = []Type{
161161
ID: "LS007",
162162
Brief: ".exe file",
163163
Description: "",
164-
MessageTemplate: ".exe file(s) found: {{.}}. Presence of these files blocks inclusion in Library Manager index.",
164+
MessageTemplate: ".exe file(s) found: {{.}}. Presence of these files blocks addition to the Library Manager index.",
165165
DisableModes: nil,
166166
EnableModes: []rulemode.Type{rulemode.Default},
167167
InfoModes: nil,
@@ -193,7 +193,7 @@ var configurations = []Type{
193193
ID: "LS009",
194194
Brief: "src folder case",
195195
Description: "",
196-
MessageTemplate: "Incorrect src folder case: {{.}}. This will cause the library to not be recognized on case-sensitive operating systems. See: https://arduino.github.io/arduino-cli/latest/library-specification/#library-root-folder",
196+
MessageTemplate: "Incorrect src folder name case: {{.}}. This will cause the library to not be recognized on case-sensitive operating systems. See: https://arduino.github.io/arduino-cli/latest/library-specification/#library-root-folder",
197197
DisableModes: nil,
198198
EnableModes: []rulemode.Type{rulemode.Default},
199199
InfoModes: nil,
@@ -207,7 +207,7 @@ var configurations = []Type{
207207
Category: "structure",
208208
Subcategory: "source code",
209209
ID: "LS010",
210-
Brief: "recursive w/ utility folder",
210+
Brief: "recursive with utility folder",
211211
Description: "",
212212
MessageTemplate: `Utility folder found in "1.5" format library. Compilation of this folder is only supported on "1.0" format libraries. See: https://arduino.github.io/arduino-cli/latest/library-specification/#source-code`,
213213
DisableModes: nil,
@@ -256,7 +256,7 @@ var configurations = []Type{
256256
Subcategory: "general",
257257
ID: "LP001",
258258
Brief: "missing library.properties",
259-
Description: `Although not required for 1.0 format libraries (AKA "legacy") not in Library Manager, metadata is useful, so it is recommended.`,
259+
Description: `Although not required for 1.0 format libraries (AKA "legacy") not in Library Manager, metadata is useful, hence recommended.`,
260260
MessageTemplate: "Library has no library.properties metadata file. This file provides useful information and is required for admission to the Library Manager index. See: https://arduino.github.io/arduino-cli/latest/library-specification/#library-metadata",
261261
DisableModes: nil,
262262
EnableModes: []rulemode.Type{rulemode.Default},
@@ -320,7 +320,7 @@ var configurations = []Type{
320320
Subcategory: "general",
321321
ID: "LP005",
322322
Brief: "library.properties format",
323-
Description: "",
323+
Description: "See: https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format",
324324
MessageTemplate: "library.properties has an invalid format: {{.}}",
325325
DisableModes: nil,
326326
EnableModes: []rulemode.Type{rulemode.Default},
@@ -353,7 +353,7 @@ var configurations = []Type{
353353
ID: "LP007",
354354
Brief: "missing name",
355355
Description: "",
356-
MessageTemplate: "Missing name field in library.properties",
356+
MessageTemplate: "Missing name field in library.properties. See: https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format",
357357
DisableModes: nil,
358358
EnableModes: []rulemode.Type{rulemode.Default},
359359
InfoModes: nil,
@@ -401,7 +401,7 @@ var configurations = []Type{
401401
ID: "LP010",
402402
Brief: "name > recommended length",
403403
Description: "",
404-
MessageTemplate: "library.properties name value {{.}} is longer than recommended max length.",
404+
MessageTemplate: "library.properties name value {{.}} is longer than the recommended length of 16 characters.",
405405
DisableModes: nil,
406406
EnableModes: []rulemode.Type{rulemode.Default},
407407
InfoModes: nil,
@@ -417,7 +417,7 @@ var configurations = []Type{
417417
ID: "LP011",
418418
Brief: "prohibited characters in name",
419419
Description: "",
420-
MessageTemplate: "Disallowed characters in library.properties name value: {{.}}. See: https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format",
420+
MessageTemplate: "Prohibited characters in library.properties name value: {{.}}. See: https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format",
421421
DisableModes: nil,
422422
EnableModes: []rulemode.Type{rulemode.Default},
423423
InfoModes: nil,
@@ -432,7 +432,7 @@ var configurations = []Type{
432432
Subcategory: "name field",
433433
ID: "LP012",
434434
Brief: `name starts with "Arduino"`,
435-
Description: `Case insensitive. 3rd party libraries added to Library Manager index prior to the enactment of this rule are "grandfathered".`,
435+
Description: `Case insensitive. Only 3rd party libraries added to the Library Manager index prior to the enactment of this rule are allowed to have this name prefix.`,
436436
MessageTemplate: `Library name {{.}} starts with "Arduino". These names are reserved for official libraries.`,
437437
DisableModes: []rulemode.Type{rulemode.Official},
438438
EnableModes: []rulemode.Type{rulemode.Default},
@@ -513,7 +513,7 @@ var configurations = []Type{
513513
ID: "LP017",
514514
Brief: "duplicate name",
515515
Description: "This requirement only applies to the library.properties name value. There is no requirement to change the repository or header file names.",
516-
MessageTemplate: "Library name {{.}} is in use by a library in the Library Manager index. Each library must have a unique name value. If library is already in the index, use the \"--library-manager update\" flag.",
516+
MessageTemplate: "Library name {{.}} is in use by a library in the Library Manager index. Each library must have a unique name value. If your library is already in the index, use the \"--library-manager update\" flag.",
517517
DisableModes: []rulemode.Type{rulemode.LibraryManagerIndexed},
518518
EnableModes: []rulemode.Type{rulemode.Default},
519519
InfoModes: nil,
@@ -609,7 +609,7 @@ var configurations = []Type{
609609
ID: "LP023",
610610
Brief: "missing author field",
611611
Description: "",
612-
MessageTemplate: "Missing required author field in library.properties. See https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format",
612+
MessageTemplate: "Missing author field in library.properties. See https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format",
613613
DisableModes: nil,
614614
EnableModes: []rulemode.Type{rulemode.Default},
615615
InfoModes: nil,
@@ -641,7 +641,7 @@ var configurations = []Type{
641641
ID: "LP025",
642642
Brief: "missing maintainer field",
643643
Description: "",
644-
MessageTemplate: "Missing required maintainer field in library.properties. See https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format",
644+
MessageTemplate: "Missing maintainer field in library.properties. See https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format",
645645
DisableModes: nil,
646646
EnableModes: []rulemode.Type{rulemode.Default},
647647
InfoModes: nil,
@@ -688,7 +688,7 @@ var configurations = []Type{
688688
Subcategory: "email field",
689689
ID: "LP028",
690690
Brief: `"email" used as alias for "maintainer"`,
691-
Description: "This was in an early draft of the beta 1.5 library specification.",
691+
Description: "This was only in an early draft of the beta 1.5 library specification.",
692692
MessageTemplate: `library.properties "email" field used as alias for "maintainer". This is deprecated.`,
693693
DisableModes: nil,
694694
EnableModes: []rulemode.Type{rulemode.Default},
@@ -737,7 +737,7 @@ var configurations = []Type{
737737
ID: "LP031",
738738
Brief: "missing sentence field",
739739
Description: "",
740-
MessageTemplate: "Missing required sentence field in library.properties. See https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format",
740+
MessageTemplate: "Missing sentence field in library.properties. See https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format",
741741
DisableModes: nil,
742742
EnableModes: []rulemode.Type{rulemode.Default},
743743
InfoModes: nil,
@@ -785,7 +785,7 @@ var configurations = []Type{
785785
ID: "LP034",
786786
Brief: "missing paragraph field",
787787
Description: "",
788-
MessageTemplate: "Missing required paragraph field in library.properties. See https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format",
788+
MessageTemplate: "Missing paragraph field in library.properties. See https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format",
789789
DisableModes: nil,
790790
EnableModes: []rulemode.Type{rulemode.Default},
791791
InfoModes: nil,
@@ -865,7 +865,7 @@ var configurations = []Type{
865865
ID: "LP039",
866866
Brief: `"Uncategorized" category value`,
867867
Description: "There is no good reason for using this non-specification compliant category value.",
868-
MessageTemplate: `Use of "Uncategorized" category value in library.properties. Please use one of the supported categories listed at https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format`,
868+
MessageTemplate: `Use of "Uncategorized" category value in library.properties. Please use one of the allowed categories: https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format`,
869869
DisableModes: nil,
870870
EnableModes: []rulemode.Type{rulemode.Default},
871871
InfoModes: nil,
@@ -881,7 +881,7 @@ var configurations = []Type{
881881
ID: "LP040",
882882
Brief: "missing url field",
883883
Description: "",
884-
MessageTemplate: "Missing required url field in library.properties. See https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format",
884+
MessageTemplate: "Missing url field in library.properties. See https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format",
885885
DisableModes: nil,
886886
EnableModes: []rulemode.Type{rulemode.Default},
887887
InfoModes: nil,
@@ -993,7 +993,7 @@ var configurations = []Type{
993993
ID: "LP047",
994994
Brief: "prohibited characters in depends",
995995
Description: "",
996-
MessageTemplate: "Disallowed characters in library.properties depends field {{.}}. See: https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format",
996+
MessageTemplate: "Prohibited characters in library.properties depends field {{.}}. See: https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format",
997997
DisableModes: nil,
998998
EnableModes: []rulemode.Type{rulemode.Default},
999999
InfoModes: nil,
@@ -1008,7 +1008,7 @@ var configurations = []Type{
10081008
Subcategory: "depends field",
10091009
ID: "LP048",
10101010
Brief: "depends not in index",
1011-
Description: "",
1011+
Description: "This field should be used to define the dependencies available from Library Manager. Library names are case-sensitive.",
10121012
MessageTemplate: "library.properties depends field item(s) {{.}} not found in the Library Manager index.",
10131013
DisableModes: nil,
10141014
EnableModes: []rulemode.Type{rulemode.Default},
@@ -1137,7 +1137,7 @@ var configurations = []Type{
11371137
ID: "LC001",
11381138
Brief: "Arduino.h case",
11391139
Description: "This causes compilation failure on filename case-sensitive OS (e.g., Linux).",
1140-
MessageTemplate: "Incorrect of Arduino.h filename case detected in #include directive: {{.}}",
1140+
MessageTemplate: "Incorrect Arduino.h filename case in #include directive: {{.}}",
11411141
DisableModes: nil,
11421142
EnableModes: []rulemode.Type{rulemode.Default},
11431143
InfoModes: nil,
@@ -1329,7 +1329,7 @@ var configurations = []Type{
13291329
ID: "SC001",
13301330
Brief: "Arduino.h case",
13311331
Description: "This causes compilation failure on filename case-sensitive OS (e.g., Linux).",
1332-
MessageTemplate: "Incorrect of Arduino.h filename case detected in #include directive: {{.}}",
1332+
MessageTemplate: "Incorrect Arduino.h filename case in #include directive: {{.}}",
13331333
DisableModes: nil,
13341334
EnableModes: []rulemode.Type{rulemode.Default},
13351335
InfoModes: nil,
@@ -1409,7 +1409,7 @@ var configurations = []Type{
14091409
ID: "PD001",
14101410
Brief: "no readme",
14111411
Description: "",
1412-
MessageTemplate: "No readme found. Please document your library. See: https://docs.github.com/en/free-pro-team@latest/github/creating-cloning-and-archiving-repositories/about-readmes",
1412+
MessageTemplate: "No readme found. Please document your boards platform. See: https://docs.github.com/en/free-pro-team@latest/github/creating-cloning-and-archiving-repositories/about-readmes",
14131413
DisableModes: nil,
14141414
EnableModes: []rulemode.Type{rulemode.Default},
14151415
InfoModes: nil,
@@ -1473,7 +1473,7 @@ var configurations = []Type{
14731473
ID: "PC001",
14741474
Brief: "Arduino.h case",
14751475
Description: "This causes compilation failure on filename case-sensitive OS (e.g., Linux).",
1476-
MessageTemplate: "Incorrect of Arduino.h filename case detected in #include directive: {{.}}",
1476+
MessageTemplate: "Incorrect Arduino.h filename case in #include directive: {{.}}",
14771477
DisableModes: nil,
14781478
EnableModes: []rulemode.Type{rulemode.Default},
14791479
InfoModes: nil,

0 commit comments

Comments
 (0)