Change function documentation

bjee19 · bjee19 · commit b8d9a89c3757 · 2024-01-23T15:37:36.000-08:00
diff --git a/internal/mode/static/state/graph/backend_refs.go b/internal/mode/static/state/graph/backend_refs.go
@@ -140,7 +140,8 @@ func createBackendRef(
 	return backendRef, nil
 }
 
-// getServiceAndPortFromRef can return an error and an empty v1.ServicePort in two cases:
+// getServiceAndPortFromRef extracts the NamespacedName of the Service and the port from a BackendRef.
+// It can return an error and an empty v1.ServicePort in two cases:
 // 1. The Service referenced from the BackendRef does not exist in the cluster/state.
 // 2. The Port on the BackendRef does not match any of the ServicePorts on the Service.
 func getServiceAndPortFromRef(

Original file line number	Diff line number	Diff line change
`@@ -140,7 +140,8 @@ func createBackendRef(`
`140`	`140`	`return backendRef, nil`
`141`	`141`	`}`
`142`	`142`
`143`		`-// getServiceAndPortFromRef can return an error and an empty v1.ServicePort in two cases:`
	`143`	`+// getServiceAndPortFromRef extracts the NamespacedName of the Service and the port from a BackendRef.`
	`144`	`+// It can return an error and an empty v1.ServicePort in two cases:`
`144`	`145`	`// 1. The Service referenced from the BackendRef does not exist in the cluster/state.`
`145`	`146`	`// 2. The Port on the BackendRef does not match any of the ServicePorts on the Service.`
`146`	`147`	`func getServiceAndPortFromRef(`