Skip to content

Commit ad66228

Browse files
committed
Fix typos in Go code doc comment
Copy/paste errors.
1 parent 882b13f commit ad66228

File tree

3 files changed

+10
-10
lines changed

3 files changed

+10
-10
lines changed

internal/project/general/general.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ PropertiesToMap converts properties.Map data structures to map[string]interface
2525
The Arduino project configuration fields have an odd usage of the properties.Map format. Dots may sometimes indicate
2626
nested keys, but in other cases they are merely a character in the key string. There are cases where a completely
2727
programmatic recursion of the properties into a fully nested structure would result in the impossibility of some keys
28-
having bot a string and a map type, which is not supported. For this reason, it's necessary to manually configure the
28+
having both a string and a map type, which is not supported. For this reason, it's necessary to manually configure the
2929
recursion of key levels on a case-by-case basis.
3030
In the event a full recursion of key levels is desired, set the levels argument to a value <1.
3131
*/

internal/project/projectdata/platform.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,7 @@ func ProgrammersTxtProgrammerIds() []string {
145145

146146
var platformTxtExists bool
147147

148-
// PlatformTxtExists returns whether the platform contains a programmer.txt file.
148+
// PlatformTxtExists returns whether the platform contains a platform.txt file.
149149
func PlatformTxtExists() bool {
150150
return platformTxtExists
151151
}

internal/rule/rulefunction/platform.go

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1657,7 +1657,7 @@ func PlatformTxtUploadParamsVerboseMissing() (result ruleresult.Type, output str
16571657
return ruleresult.Pass, ""
16581658
}
16591659

1660-
// PlatformTxtUploadParamsQuietMissing checks if any of the programmers are missing upload.params.quiet properties.
1660+
// PlatformTxtUploadParamsQuietMissing checks if any of the tools are missing upload.params.quiet properties.
16611661
func PlatformTxtUploadParamsQuietMissing() (result ruleresult.Type, output string) {
16621662
if !projectdata.PlatformTxtExists() {
16631663
return ruleresult.Skip, "Platform has no platform.txt"
@@ -1680,7 +1680,7 @@ func PlatformTxtUploadParamsQuietMissing() (result ruleresult.Type, output strin
16801680
return ruleresult.Pass, ""
16811681
}
16821682

1683-
// PlatformTxtUploadPatternMissing checks if any of the programmers are missing upload.pattern properties.
1683+
// PlatformTxtUploadPatternMissing checks if any of the tools are missing upload.pattern properties.
16841684
func PlatformTxtUploadPatternMissing() (result ruleresult.Type, output string) {
16851685
if !projectdata.PlatformTxtExists() {
16861686
return ruleresult.Skip, "Platform has no platform.txt"
@@ -1726,7 +1726,7 @@ func PlatformTxtProgramParamsVerboseMissing() (result ruleresult.Type, output st
17261726
return ruleresult.Pass, ""
17271727
}
17281728

1729-
// PlatformTxtProgramParamsQuietMissing checks if any of the programmers are missing program.params.quiet properties.
1729+
// PlatformTxtProgramParamsQuietMissing checks if any of the tools are missing program.params.quiet properties.
17301730
func PlatformTxtProgramParamsQuietMissing() (result ruleresult.Type, output string) {
17311731
if !projectdata.PlatformTxtExists() {
17321732
return ruleresult.Skip, "Platform has no platform.txt"
@@ -1749,7 +1749,7 @@ func PlatformTxtProgramParamsQuietMissing() (result ruleresult.Type, output stri
17491749
return ruleresult.Pass, ""
17501750
}
17511751

1752-
// PlatformTxtProgramPatternMissing checks if any of the programmers are missing program.pattern properties.
1752+
// PlatformTxtProgramPatternMissing checks if any of the tools are missing program.pattern properties.
17531753
func PlatformTxtProgramPatternMissing() (result ruleresult.Type, output string) {
17541754
if !projectdata.PlatformTxtExists() {
17551755
return ruleresult.Skip, "Platform has no platform.txt"
@@ -1795,7 +1795,7 @@ func PlatformTxtEraseParamsVerboseMissing() (result ruleresult.Type, output stri
17951795
return ruleresult.Pass, ""
17961796
}
17971797

1798-
// PlatformTxtEraseParamsQuietMissing checks if any of the programmers are missing erase.params.quiet properties.
1798+
// PlatformTxtEraseParamsQuietMissing checks if any of the tools are missing erase.params.quiet properties.
17991799
func PlatformTxtEraseParamsQuietMissing() (result ruleresult.Type, output string) {
18001800
if !projectdata.PlatformTxtExists() {
18011801
return ruleresult.Skip, "Platform has no platform.txt"
@@ -1818,7 +1818,7 @@ func PlatformTxtEraseParamsQuietMissing() (result ruleresult.Type, output string
18181818
return ruleresult.Pass, ""
18191819
}
18201820

1821-
// PlatformTxtErasePatternMissing checks if any of the programmers are missing erase.pattern properties.
1821+
// PlatformTxtErasePatternMissing checks if any of the tools are missing erase.pattern properties.
18221822
func PlatformTxtErasePatternMissing() (result ruleresult.Type, output string) {
18231823
if !projectdata.PlatformTxtExists() {
18241824
return ruleresult.Skip, "Platform has no platform.txt"
@@ -1864,7 +1864,7 @@ func PlatformTxtBootloaderParamsVerboseMissing() (result ruleresult.Type, output
18641864
return ruleresult.Pass, ""
18651865
}
18661866

1867-
// PlatformTxtBootloaderParamsQuietMissing checks if any of the programmers are missing bootloader.params.quiet properties.
1867+
// PlatformTxtBootloaderParamsQuietMissing checks if any of the tools are missing bootloader.params.quiet properties.
18681868
func PlatformTxtBootloaderParamsQuietMissing() (result ruleresult.Type, output string) {
18691869
if !projectdata.PlatformTxtExists() {
18701870
return ruleresult.Skip, "Platform has no platform.txt"
@@ -1887,7 +1887,7 @@ func PlatformTxtBootloaderParamsQuietMissing() (result ruleresult.Type, output s
18871887
return ruleresult.Pass, ""
18881888
}
18891889

1890-
// PlatformTxtBootloaderPatternMissing checks if any of the programmers are missing bootloader.pattern properties.
1890+
// PlatformTxtBootloaderPatternMissing checks if any of the tools are missing bootloader.pattern properties.
18911891
func PlatformTxtBootloaderPatternMissing() (result ruleresult.Type, output string) {
18921892
if !projectdata.PlatformTxtExists() {
18931893
return ruleresult.Skip, "Platform has no platform.txt"

0 commit comments

Comments
 (0)