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 <nicolas.deloof@gmail.com>
This commit is contained in:
Nicolas De Loof 2026-10-26 14:50:34 +01:00 • committed by Nicolas De loof
parent 7259254c76
commit 3ec2fc7620

View file

@ -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