Merge 3f8b0ac into 1850729

vmware-labs · Oct 16, 2023 · de446fd · de446fd
2 parents 1850729 + 3f8b0ac
commit de446fd
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/reconcilers/childset.go b/reconcilers/childset.go
@@ -93,6 +93,9 @@ type ChildSetReconciler[Type, ChildType client.Object, ChildListType client.Obje
 	//
 	// Most errors are returned directly, skipping this method. The set of handled error types
 	// may grow, implementations should be defensive rather than assuming the error type.
+	//
+	// Results contain the union of desired and actual child resources, in the order they were
+	// reconciled, (sorted by identifier).
 	ReflectChildrenStatusOnParent func(ctx context.Context, parent Type, result ChildSetResult[ChildType])
 
 	// HarmonizeImmutableFields allows fields that are immutable on the current