From 984f85d454e369299a9067a1ea11028e6451b0aa Mon Sep 17 00:00:00 2001 From: "Sean P. McDonald" Date: Thu, 18 Apr 2024 12:41:40 -0500 Subject: [PATCH] (maint) Fix ctrl::do_until docs The docs mischaracterized the return value of ctrl::do_until as `nil`. That function returns the value of the given code block's last iteration --- bolt-modules/ctrl/lib/puppet/functions/ctrl/do_until.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/bolt-modules/ctrl/lib/puppet/functions/ctrl/do_until.rb b/bolt-modules/ctrl/lib/puppet/functions/ctrl/do_until.rb index 1240bb51b1..2b719bb250 100644 --- a/bolt-modules/ctrl/lib/puppet/functions/ctrl/do_until.rb +++ b/bolt-modules/ctrl/lib/puppet/functions/ctrl/do_until.rb @@ -6,7 +6,7 @@ # @param block The code block to repeat. # @option options [Numeric] limit The number of times to repeat the block. # @option options [Numeric] interval The number of seconds to wait before repeating the block. - # @return [nil] + # @return The value of the code block's last iteration # @example Run a task until it succeeds # ctrl::do_until() || { # run_task('test', $target, '_catch_errors' => true).ok()