put examples back in for internal fxns

NAMESPACE

@@ -95,7 +95,10 @@ export(figure_out_policy_arn)
 export(group_policies)
 export(instance_details)
 export(ip_permissions_generator)
+export(path_as_s3)
 export(path_from)
+export(path_s3_build)
+export(path_s3_parse)
 export(random_bucket)
 export(random_role)
 export(random_string)

R/ui_fetch_secret.R

@@ -14,6 +14,14 @@
 #' to use. If you choose none of them this function returns NULL for
 #' both user and password
 #' @keywords internal
+#' @examples \dontrun{
+#' # user,pwd supplied, return them right away at top of fxn
+#' ui_fetch_secret(engine = "mariadb", user = "jane", password = "apple")
+#'
+#' # user,pwd null
+#' ui_fetch_secret(engine = "redshift")
+#' ui_fetch_secret(engine = "mariadb")
+#' }
 ui_fetch_secret <- function(
   user = NULL,
   password = NULL,

R/utils.R

@@ -63,10 +63,28 @@ check_for_pkg <- function(x) {
 
 #' Parse s3 paths
 #'
+#' @export
 #' @keywords internal
 #' @param paths (character) one or more s3 paths
 #' @return an unnamed list with each slot a named list with bucket, path,
 #' and file
+#' @examples
+#' path_s3_parse("s3://s64-test-2/DESCRIPTION")
+#' path_s3_parse("s3://s64-test-2/some/other/path/things.csv")
+#' paths <- c(
+#'   "s3://s64-test-2/DESCRIPTION",
+#'   "s3://s64-test-2/stuff.txt",
+#'   "s3://s64-test-2/some/other/path/things.csv"
+#' )
+#' path_s3_parse(paths)
+#'
+#' # if a path is not an s3 path
+#' paths <- c(
+#'   "s3://s64-test-2/DESCRIPTION",
+#'   "s3://s64-test-2/stuff.txt",
+#'   "s64-test-2/some/other/path/things.csv"
+#' )
+#' try(path_s3_parse(paths))
 path_s3_parse <- function(paths) {
   list_names <- c("bucket", "path", "file")
   stopifnot("One or more paths are not s3 paths" = all(grepl("^s3://", paths)))
@@ -87,8 +105,17 @@ path_s3_parse <- function(paths) {
 
 #' Build s3 paths
 #'
+#' @export
 #' @keywords internal
 #' @param x unnamed list of parsed paths, from [path_s3_parse()]
+#' @examples
+#' paths <- c(
+#'   "s3://s64-test-2/DESCRIPTION",
+#'   "s3://s64-test-2/stuff.txt",
+#'   "s3://s64-test-2/some/other/path/things.csv"
+#' )
+#' x <- path_s3_parse(paths)
+#' path_s3_build(x)
 path_s3_build <- function(x) {
   purrr::map_vec(x, function(w) {
     path <- if (nzchar(w$path)) paste0(w$path, "/") else ""
@@ -100,10 +127,19 @@ path_s3_build <- function(x) {
 
 #' Convert a s3 like path to a single format
 #'
+#' @export
 #' @keywords internal
 #' @inheritParams path_s3_parse
 #' @return vector of s3 paths (character), Of the form:
 #' `s3://<bucket>/<path>/<file>`
+#' @examples
+#' path_as_s3("http://s64-test-3.s3.amazonaws.com/")
+#' path_as_s3("https://s64-test-3.s3.amazonaws.com/")
+#' path_as_s3(c(
+#'   "https://s64-test-3.s3.amazonaws.com/",
+#'   "https://mybucket.s3.amazonaws.com/"
+#' ))
+#' path_as_s3(c("apple", "banana", "pear", "pineapple"))
 path_as_s3 <- function(paths) {
   paths <- gsub("https?://", "", paths)
   paths <- gsub("\\.s3.+", "", paths)
@@ -146,6 +182,7 @@ paginate_aws_marker <- function(fun, target, ...) {
 #' @importFrom rlang is_empty
 #' @inheritParams paginate_aws_marker
 #' @keywords internal
+#' @note `paginate_aws_token(fun=con_sm()$list_secrets, target="SecretList")`
 paginate_aws_token <- function(fun, target, ...) {
   con <- con_sm()
   res <- con[[fun]](...)

R/wait.R

@@ -38,6 +38,9 @@ wait_until <- function(fun, message) {
 #' @return nothing, exits if there's an error, or if the while
 #' loop completes
 #' @keywords internal
+#' @examples \dontrun{
+#' wait_for_cluster(id = "scotts-test-cluster-456")
+#' }
 wait_for_cluster <- wait_until(
   aws_db_cluster_status,
   "Redshift cluster initializing"
@@ -49,6 +52,9 @@ wait_for_cluster <- wait_until(
 #' @return nothing, exits if there's an error, or if the while
 #' loop completes
 #' @keywords internal
+#' @examples \dontrun{
+#' wait_for_instance(id = "scotts-test-cluster-456")
+#' }
 wait_for_instance <- wait_until(
   aws_db_instance_status,
   "RDS instance initializing"