Small fix to documentation, adds some instructions to tests

rstudio · Sep 30, 2024 · c5bfbcc · c5bfbcc
1 parent 6452b77
commit c5bfbcc
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 4 deletions.
diff --git a/R/board-databricks.R b/R/board-databricks.R
@@ -26,8 +26,8 @@
 #' folder. For example: /Volumes/my-catalog/my-schema/my-volume.
 #' @param host Your [Workspace Instance URL](https://docs.databricks.com/en/workspace/workspace-details.html#workspace-url).
 #' If `NULL`, it will search for URL in two different environment variables:
-#' - DATABRICKS_HOST
-#' - CONNECT_DATABRICKS_HOST
+#' - 'DATABRICKS_HOST'
+#' - 'CONNECT_DATABRICKS_HOST'
 #'
 #' Defaults to `NULL`.
 #' @param prefix 	Prefix within this bucket that this board will occupy.

diff --git a/man/board_databricks.Rd b/man/board_databricks.Rd
diff --git a/tests/testthat/test-board-databricks.R b/tests/testthat/test-board-databricks.R
@@ -1,3 +1,8 @@
+# To run these tests, you will need a Databricks Volume, with read/write access,
+# and the following environment variables set:
+# PINS_DATABRICKS_FOLDER_URL - The path to your Databricks Volume
+# DATABRICKS_HOST - Your Workpace Instance URL
+# DATABRICKS_TOKEN - Your PAT
 skip_if_not_installed("httr2")
 test_that("Deparse works", {
   expect_snapshot(board_databricks("THIS-IS-A-TEST", host = "NOT-A-HOST"))