Update success and failing state comments

charlieegan3 · charlieegan3 · commit c78e83763cfc · 2020-01-10T17:15:52.000Z
Signed-off-by: Charlie Egan &lt;charlieegan3@users.noreply.github.com&gt;
diff --git a/pkg/results/results.go b/pkg/results/results.go
@@ -27,7 +27,8 @@ type Result struct {
 	Package string
 }
 
-// IsSuccessState returns true if Value is boolean and it is true.
+// IsSuccessState returns true if there are no Violations
+// If Violations are missing, the Value is parsed and if it is a bool that is used, otherwise false
 func (r *Result) IsSuccessState() bool {
 	if r.Violations != nil {
 		return len(r.Violations) == 0
@@ -42,7 +43,8 @@ func (r *Result) IsSuccessState() bool {
 	}
 }
 
-// IsFailureState returns true if Value is boolean and it is false.
+// IsFailureState returns true if there are Violations
+// If Violations are missing, the Value is parsed and if it is a bool that is negated and returned, otherwise false
 func (r *Result) IsFailureState() bool {
 	if r.Violations != nil {
 		return len(r.Violations) != 0

Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,8 @@ type Result struct {`
`27`	`27`	`Package string`
`28`	`28`	`}`
`29`	`29`
`30`		`-// IsSuccessState returns true if Value is boolean and it is true.`
	`30`	`+// IsSuccessState returns true if there are no Violations`
	`31`	`+// If Violations are missing, the Value is parsed and if it is a bool that is used, otherwise false`
`31`	`32`	`func (r *Result) IsSuccessState() bool {`
`32`	`33`	`if r.Violations != nil {`
`33`	`34`	`return len(r.Violations) == 0`
`@@ -42,7 +43,8 @@ func (r *Result) IsSuccessState() bool {`
`42`	`43`	`}`
`43`	`44`	`}`
`44`	`45`
`45`		`-// IsFailureState returns true if Value is boolean and it is false.`
	`46`	`+// IsFailureState returns true if there are Violations`
	`47`	`+// If Violations are missing, the Value is parsed and if it is a bool that is negated and returned, otherwise false`
`46`	`48`	`func (r *Result) IsFailureState() bool {`
`47`	`49`	`if r.Violations != nil {`
`48`	`50`	`return len(r.Violations) != 0`