From 3ec2fc76205f2f8e600edb448a6a27ed19368d62 Mon Sep 17 00:00:00 2001 From: Nicolas De Loof Date: Mon, 26 Oct 2026 14:50:34 +0100 Subject: [PATCH] docs(api): StartOptions.Wait is rejected together with Attach UpOptions.Validate now refuses the combination, so the field's doc says that instead of describing a foreground Up that silently skips the verification. Signed-off-by: Nicolas De Loof --- pkg/api/api.go | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/pkg/api/api.go b/pkg/api/api.go index 98516ebad..0c4074fc2 100644 --- a/pkg/api/api.go +++ b/pkg/api/api.go @@ -384,8 +384,8 @@ type StartOptions struct { // by Up's foreground session only; ignored by Start. ExitCodeFrom string // Wait won't return until containers reached the running|healthy state. - // Honored by a detached Up (Attach nil); a foreground Up is not followed - // by this verification. + // Up honors it in detached mode only (Attach nil): combined with Attach it + // is rejected, see UpOptions.Validate. Wait bool WaitTimeout time.Duration // Services names the services the user explicitly targeted; it only