Cleaning up and updating pkgdown with check github_pat

NAMESPACE

@@ -1,5 +1,6 @@
 # Generated by roxygen2: do not edit by hand
 
+export(check_github_pat)
 export(check_proxy_settings)
 export(check_renv_download_method)
 export(comma_sep)

R/diagnostic_test.R

@@ -70,7 +70,7 @@ check_proxy_settings <- function(
   } else {
     message("PASS: No proxy settings found in your Git configuration.")
     proxy_config <- as.list(rep("", length(proxy_setting_names))) |>
-      setNames(proxy_setting_names)
+      stats::setNames(proxy_setting_names)
   }
   return(proxy_config)
 }
@@ -79,8 +79,8 @@ check_proxy_settings <- function(
 #'
 #' @description
 #' If the GITHUB_PAT keyword is set, then it can cause issues with R installing
-#' packages from GitHub (usually with an error of "ERROR [curl: (22) The
-#' requested URL returned error: 401]"). This script checks whether the keyword
+#' packages from GitHub (usually with an error of "ERROR \[curl: (22) The
+#' requested URL returned error: 401\]"). This script checks whether the keyword
 #' is set and can then clear it (if clear=TRUE).
 #' The user will then need to identify where the "GITHUB_PAT" variable is being
 #' set from and remove it to permanently fix the issue.

_pkgdown.yml

@@ -47,6 +47,7 @@ reference:
   contents:
   - diagnostic_test
   - check_proxy_settings
+  - check_github_pat
   - check_renv_download_method
 
 - title: Helpers

tests/testthat/test-diagnostic_test.R

@@ -1,7 +1,7 @@
 test_that("Check proxy settings identifies and removes proxy setting", {
   # Set a dummy config parameter for the purposes of testing
   git2r::config(http.proxy.test = "this-is-a-test-entry", global = TRUE)
-  proxy_setting_names = c("http.proxy.test", "https.proxy.test")
+  proxy_setting_names <- c("http.proxy.test", "https.proxy.test")
   # Check that check_proxy_settings identifies the rogue entry
   expect_equal(
     check_proxy_settings(
@@ -27,7 +27,7 @@ test_that("Check proxy settings identifies and removes proxy setting", {
     ) |>
       suppressMessages(),
     proxy_config <- as.list(rep("", length(proxy_setting_names))) |>
-      setNames(proxy_setting_names)
+      stats::setNames(proxy_setting_names)
   )
 })