Skip to content

Commit

Permalink
(maint) Fix ctrl::do_until docs
Browse files Browse the repository at this point in the history
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
  • Loading branch information
mcdonaldseanp committed Apr 18, 2024
1 parent b7738e2 commit 2a98174
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion bolt-modules/ctrl/lib/puppet/functions/ctrl/do_until.rb
Original file line number Diff line number Diff line change
Expand Up @@ -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()
Expand Down

0 comments on commit 2a98174

Please sign in to comment.