providers/supermicro/supermicro.go: Explain why we return nil in NewC…

…lient()
bmc-toolbox · Oct 29, 2024 · 0a6db1f · 0a6db1f
1 parent 9705c04
commit 0a6db1f
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/providers/supermicro/supermicro.go b/providers/supermicro/supermicro.go
@@ -144,6 +144,9 @@ func NewClient(host, user, pass string, log logr.Logger, opts ...Option) *Client
 		httpclient.Build(defaultConfig.httpClientSetupFuncs...),
 	)
 
+	// We probably want to treat this as a fatal error and/or pass the error back to the caller
+	// I did not want to chase that thread atm, so we intentionally return nil here if
+	// newBmcServiceClient returns an error.
 	if err != nil {
 		return nil
 	}