Skip to content

Commit 2a98174

Browse files
committed
(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 !no-release-note
1 parent b7738e2 commit 2a98174

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

bolt-modules/ctrl/lib/puppet/functions/ctrl/do_until.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
# @param block The code block to repeat.
77
# @option options [Numeric] limit The number of times to repeat the block.
88
# @option options [Numeric] interval The number of seconds to wait before repeating the block.
9-
# @return [nil]
9+
# @return The value of the code block's last iteration
1010
# @example Run a task until it succeeds
1111
# ctrl::do_until() || {
1212
# run_task('test', $target, '_catch_errors' => true).ok()

0 commit comments

Comments
 (0)