From d4fd591dd304dda3235565bef9bc73fc922fd8d2 Mon Sep 17 00:00:00 2001 From: Nithwin <132214352+Nithwin@users.noreply.github.com> Date: Mon, 10 Aug 2026 23:15:37 +0530 Subject: [PATCH] docs: fix incorrect godoc comments on WithVersionCheck and WithFailfast (#2963) --- executor.go | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/executor.go b/executor.go index 14b422f3..8ed87bec 100644 --- a/executor.go +++ b/executor.go @@ -621,7 +621,8 @@ func (o *ioOption) ApplyToExecutor(e *Executor) { e.Stderr = o.rw } -// WithVersionCheck tells the [Executor] whether or not to check the version of +// WithVersionCheck tells the [Executor] whether or not to check the schema +// version of the Taskfile before running. func WithVersionCheck(enableVersionCheck bool) ExecutorOption { return &versionCheckOption{enableVersionCheck} } @@ -634,7 +635,8 @@ func (o *versionCheckOption) ApplyToExecutor(e *Executor) { e.EnableVersionCheck = o.enableVersionCheck } -// WithFailfast tells the [Executor] whether or not to check the version of +// WithFailfast tells the [Executor] to stop running tasks as soon as any task +// returns an error. func WithFailfast(failfast bool) ExecutorOption { return &failfastOption{failfast} }