update comments on builders

kubernetes-sigs · Oct 20, 2021 · 1331e55 · 1331e55
1 parent a3004ed
commit 1331e55
Showing 1 changed file with 32 additions and 5 deletions.
diff --git a/internal/builder/builders.go b/internal/builder/builders.go
@@ -345,7 +345,14 @@ func InfrastructureMachineTemplate(namespace, name string) *InfrastructureMachin
 	}
 }
 
-// WithSpecFields will add fields of any type to the object spec. It takes an argument, fields, which is of the form path: object.
+// WithSpecFields sets a map of spec fields on the unstructured object. The keys in the map represent the path and the value corresponds
+// to the value of the spec field.
+//
+// Note: all the paths should start with "spec."
+//
+// Example map: map[string]interface{}{
+//     "spec.version": "v1.2.3",
+// }.
 func (i *InfrastructureMachineTemplateBuilder) WithSpecFields(fields map[string]interface{}) *InfrastructureMachineTemplateBuilder {
 	i.specFields = fields
 	return i
@@ -409,7 +416,14 @@ func InfrastructureClusterTemplate(namespace, name string) *InfrastructureCluste
 	}
 }
 
-// WithSpecFields will add fields of any type to the object spec. It takes an argument, fields, which is of the form path: object.
+// WithSpecFields sets a map of spec fields on the unstructured object. The keys in the map represent the path and the value corresponds
+// to the value of the spec field.
+//
+// Note: all the paths should start with "spec."
+//
+// Example map: map[string]interface{}{
+//     "spec.version": "v1.2.3",
+// }.
 func (i *InfrastructureClusterTemplateBuilder) WithSpecFields(fields map[string]interface{}) *InfrastructureClusterTemplateBuilder {
 	i.specFields = fields
 	return i
@@ -447,7 +461,14 @@ func ControlPlaneTemplate(namespace, name string) *ControlPlaneTemplateBuilder {
 	}
 }
 
-// WithSpecFields will add fields of any type to the object spec. It takes an argument, fields, which is of the form path: object.
+// WithSpecFields sets a map of spec fields on the unstructured object. The keys in the map represent the path and the value corresponds
+// to the value of the spec field.
+//
+// Note: all the paths should start with "spec."
+//
+// Example map: map[string]interface{}{
+//     "spec.version": "v1.2.3",
+// }.
 func (c *ControlPlaneTemplateBuilder) WithSpecFields(fields map[string]interface{}) *ControlPlaneTemplateBuilder {
 	c.specFields = fields
 	return c
@@ -487,7 +508,14 @@ type InfrastructureClusterBuilder struct {
 	specFields map[string]interface{}
 }
 
-// WithSpecFields will add fields of any type to the object spec. It takes an argument, fields, which is of the form path: object.
+// WithSpecFields sets a map of spec fields on the unstructured object. The keys in the map represent the path and the value corresponds
+// to the value of the spec field.
+//
+// Note: all the paths should start with "spec."
+//
+// Example map: map[string]interface{}{
+//     "spec.version": "v1.2.3",
+// }.
 func (i *InfrastructureClusterBuilder) WithSpecFields(fields map[string]interface{}) *InfrastructureClusterBuilder {
 	i.specFields = fields
 	return i
@@ -643,7 +671,6 @@ func (m *MachineDeploymentBuilder) WithGeneration(generation int64) *MachineDepl
 }
 
 // WithStatus sets the passed status object as the status of the machine deployment object.
-// TODO (killianmuldoon): Revise making this method consistent with WithSpec fields in objectbuilders.
 func (m *MachineDeploymentBuilder) WithStatus(status clusterv1.MachineDeploymentStatus) *MachineDeploymentBuilder {
 	m.status = &status
 	return m