Skip to content

Put examples back in for unexported functions #124

@sckott

Description

@sckott

cran wanted them out, put em back in after 1st version up:

paginate_aws_token

#' @examplesIf aws_has_creds()
#' paginate_aws_token(
#'   fun = con_sm()$list_secrets,
#'   target = "SecretList"
#' )

path_as_s3

#' @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_s3_build

#' @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_parse

#' @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"
#' )
#' path_s3_parse(paths)

ui_fetch_secret

#' @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")
#' }

wait_for_cluster

#' @examples \dontrun{
#' wait_for_cluster(id = "scotts-test-cluster-456")
#' }

wait_for_instance

#' @examples \dontrun{
#' wait_for_instance(id = "scotts-test-cluster-456")
#' }

Metadata

Metadata

Assignees

Labels

documentation 📖Improvements or additions to documentation

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions