From 799560695b48707d3c1f113b24d658d5f4cf50d1 Mon Sep 17 00:00:00 2001 From: Jared O'Connell Date: Thu, 19 Sep 2024 15:00:27 -0400 Subject: [PATCH] Improved comment for a test --- workflow/workflow_test.go | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/workflow/workflow_test.go b/workflow/workflow_test.go index ef420e3..ae1c7c8 100644 --- a/workflow/workflow_test.go +++ b/workflow/workflow_test.go @@ -2266,7 +2266,10 @@ outputs: ` func TestSoftOptionalFieldWorkflow(t *testing.T) { - // Test the wait time resulting in the soft-optional not being included. + // This test case handles the soft optional dependency. It uses timing and step + // enablement. Timing is used since there are no order guarantees provided by + // `!soft-optional` alone. If this proves to be fragile, consider utilizing + // multiple steps that wait for each other in a way that ensures proper ordering. preparedWorkflow := assert.NoErrorR[workflow.ExecutableWorkflow](t)( getTestImplPreparedWorkflow(t, softOptionalFieldWorkflow), )