Add initializer for PartialResult #110
Merged
+9
−0
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit adds a NewPartialResult function which returns a
PartialResult struct with "sane" default, mainly setting the
defaultState to "Unknown".
This should help developers implementing this library, since it
avoids the following pattern:
sc := result.PartialResult{}
sc.setDefaultState(check.Unknown)
This pattern is quite common, but in a sense useless.
martialblog
reviewed
Feb 13, 2024
| @@ -41,6 +41,13 @@ type PartialResult struct { | |||
| defaultStateSet bool // nolint: unused | |||
| } | |||
|
|
|||
| func NewPartialResult() PartialResult { | |||
There was a problem hiding this comment.
Look alright. But could you add a doc string for the function, maybe describe why the defaults are what they are?
martialblog
approved these changes
Feb 13, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This commit adds a NewPartialResult function which returns a PartialResult struct with "sane" default, mainly setting the defaultState to "Unknown".
This should help developers implementing this library, since it avoids the following pattern:
sc := result.PartialResult{}
sc.setDefaultState(check.Unknown)
This pattern is quite common, but in a sense useless.