From 3f8b0ac1cd850f2a503b185db64a2e58281f707a Mon Sep 17 00:00:00 2001 From: Scott Andrews Date: Mon, 16 Oct 2023 11:07:41 -0400 Subject: [PATCH] Clarify ChildSetReconciler doc Signed-off-by: Scott Andrews --- reconcilers/childset.go | 3 +++ 1 file changed, 3 insertions(+) diff --git a/reconcilers/childset.go b/reconcilers/childset.go index 19b1e37..cc1465d 100644 --- 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