📝 Update / simplify the Getting Started vignette

.Renviron.example

@@ -0,0 +1,2 @@
+AZ_STORAGE_EP=[your azure blob storage endpoint url]
+AZ_TABLE_EP=[your azure table storage endpoint url]

R/get_auth_token.R

@@ -18,8 +18,8 @@
 #'  to help provide an appropriate string or vector.
 #'  If setting version to 2, ensure that the `aad_version` argument is also set
 #'  to 2. Both are set to use AAD version 1 by default.
-#' @param tenant A string specifying the Azure tenant. Defaults to
-#'  `"common"`. See [AzureAuth::get_azure_token] for other values.
+#' @param tenant A string specifying the Azure tenant. Defaults to `"common"`.
+#'  See [AzureAuth::get_azure_token] for other values.
 #' @param client_id A string specifying the application ID (aka client ID). If
 #'  `NULL`, (the default) the function attempts to obtain the client ID from the
 #'  Azure Resource Manager token, or prompts the user to log in to obtain it.

R/list_files.R

@@ -28,7 +28,7 @@
 list_files <- function(container, dir = "", ext = "", recursive = FALSE) {
   stopifnot(rlang::is_character(c(dir, ext), 2))
   stopifnot(rlang::is_bool(recursive))
-  pnf_msg <- ct_error_msg("Path {.val {path}} not found")
+  pnf_msg <- ct_error_msg("Path {.val {dir}} not found")
   check_that(dir, \(x) AzureStor::blob_dir_exists(container, x), pnf_msg)
 
   ext_rx <- ifelse(nzchar(ext), gsub("^\\.+", "\\.", ext), ".*") # nolint
@@ -40,7 +40,7 @@ list_files <- function(container, dir = "", ext = "", recursive = FALSE) {
   if (nrow(tbl) == 0) {
     fix_path <- \(p) sub("^/+$", "", sub("^([^/])(.*)", "/\\1\\2", p)) # nolint
     ext <- if (nzchar(ext)) paste0(" ", ext)
-    msg <- "No{ext} files found in {.val [{container$name}]:{fix_path(path)}}"
+    msg <- "No{ext} files found in {.val [{container$name}]:{fix_path(dir)}}"
     cli::cli_alert_info(msg)
     invisible(character(0))
   } else {

README.md

@@ -97,7 +97,7 @@ csv_data <- data_container |>
 
 ## Environment variables
 
-To facilitate access to Azure Storage you may want to set some environment
+To facilitate access to Azure Storage you should set some environment
 variables.
 The neatest way to do this is to include a [`.Renviron` file][posit_env] in
 your project folder.