Skip to content

Commit c98d787

Browse files
authored
Merge pull request #144 from arduino/per1234/correct-doc-comments
Correct doc comments
2 parents 38c2f3f + a8bafab commit c98d787

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

Diff for: internal/rule/rulefunction/platform.go

+3-3
Original file line numberDiff line numberDiff line change
@@ -192,7 +192,7 @@ func BoardsTxtUserExtraFlagsUsage() (result ruleresult.Type, output string) {
192192
return ruleresult.Pass, ""
193193
}
194194

195-
// BoardsTxtBoardIDHideInvalid checks if any of the board hide values are less than the minimum length.
195+
// BoardsTxtBoardIDHideInvalid checks if any of the board hide values have invalid format
196196
func BoardsTxtBoardIDHideInvalid() (result ruleresult.Type, output string) {
197197
if projectdata.BoardsTxtLoadError() != nil {
198198
return ruleresult.NotRun, "Couldn't load boards.txt"
@@ -1622,7 +1622,7 @@ func PlatformTxtProgramPatternMissing() (result ruleresult.Type, output string)
16221622
return ruleresult.Pass, ""
16231623
}
16241624

1625-
// PlatformTxtEraseParamsVerboseMissing checks if any of the tools are missing erase.params.verbos properties.
1625+
// PlatformTxtEraseParamsVerboseMissing checks if any of the tools are missing erase.params.verbose properties.
16261626
func PlatformTxtEraseParamsVerboseMissing() (result ruleresult.Type, output string) {
16271627
if !projectdata.PlatformTxtExists() {
16281628
return ruleresult.Skip, "Platform has no platform.txt"
@@ -1691,7 +1691,7 @@ func PlatformTxtErasePatternMissing() (result ruleresult.Type, output string) {
16911691
return ruleresult.Pass, ""
16921692
}
16931693

1694-
// PlatformTxtBootloaderParamsVerboseMissing checks if any of the tools are missing bootloader.params.verbos properties.
1694+
// PlatformTxtBootloaderParamsVerboseMissing checks if any of the tools are missing bootloader.params.verbose properties.
16951695
func PlatformTxtBootloaderParamsVerboseMissing() (result ruleresult.Type, output string) {
16961696
if !projectdata.PlatformTxtExists() {
16971697
return ruleresult.Skip, "Platform has no platform.txt"

0 commit comments

Comments
 (0)