Skip to content

Commit

Permalink
add internal man file for wait_until fxn generator; fix man file for …
Browse files Browse the repository at this point in the history
…wait_for_* fxns
  • Loading branch information
sckott committed Aug 26, 2024
1 parent 13aade6 commit 3692a93
Show file tree
Hide file tree
Showing 4 changed files with 33 additions and 17 deletions.
14 changes: 9 additions & 5 deletions R/wait.R
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
# wait fxn generator
#' wait fxn generator
#' @param fun (function) a function to check status of something;
#' must return a single boolean, e.g., `aws_db_cluster_status` or
#' `aws_db_instance_status`
#' @param message (character) the message to print at the beginning
#' of `cli::cli_progress_bar`
#' @keywords internal
wait_until <- function(fun, message) {
function(id, sleep = 2, status_target = "available") {
cli::cli_alert_info(c(
Expand All @@ -24,10 +30,8 @@ wait_until <- function(fun, message) {
#' Wait for a Redshift cluster to have a certain status
#'
#' @importFrom cli cli_progress_bar cli_progress_update pb_spin
#' @inheritParams aws_db_redshift_create
#' @param fun (function) a function to check status of something;
#' must return a single boolean, e.g., `aws_db_cluster_status` or
#' `aws_db_instance_status`
#' @param id (character) an RDS instance identifier, or a Redshift
#' cluster identifier. required
#' @param sleep (integer/numeric) number of seconds to wait between
#' checks of the cluster status (i.e., http requests)
#' @param status_target (character) status to wait for. default: "available"
Expand Down
10 changes: 2 additions & 8 deletions man/wait_for_cluster.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 2 additions & 4 deletions man/wait_for_instance.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

20 changes: 20 additions & 0 deletions man/wait_until.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 3692a93

Please sign in to comment.