Skip to content

Add initializer for PartialResult #110

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
RincewindsHat merged 2 commits into from
Feb 13, 2024
Merged

Add initializer for PartialResult #110

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
edb0439
Add initializer for PartialResult
Feb 12, 2024
3557937
Add a little bit of documentation to the new initializer
Feb 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions result/overall.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,15 @@ type PartialResult struct {
defaultStateSet bool // nolint: unused
}

// Initializer for a PartialResult with "sane" defaults
// Notable default compared to the nil object: the default state is set to Unknown
func NewPartialResult() PartialResult {
Copy link
Copy Markdown
Member

@martialblog martialblog Feb 13, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Look alright. But could you add a doc string for the function, maybe describe why the defaults are what they are?

return PartialResult{
stateSetExplicitly: false,
defaultState: check.Unknown,
}
}

// String returns the status and output of the PartialResult
func (s *PartialResult) String() string {
return fmt.Sprintf("[%s] %s", check.StatusText(s.GetStatus()), s.Output)
Expand Down