Updating diagnostics documentation

R/diagnostic_test.R

@@ -13,9 +13,7 @@
 #' @export
 #'
 #' @examples
-#' \dontrun{
 #' diagnostic_test()
-#' }
 diagnostic_test <- function(
     clean = FALSE,
     verbose = FALSE) {
@@ -133,7 +131,7 @@ check_renv_download_method <- function(
       )
       readRenviron(renviron_file)
     } else {
-      dfeR::toggle_message(current_setting_message,
+      dfeR::toggle_message(paste("FAIL:", current_setting_message),
         verbose = verbose
       )
       message("If you wish to manually update your .Renviron file:")

_pkgdown.yml

@@ -42,6 +42,13 @@ reference:
   contents:
   - starts_with("format_")
 
+- title: System diagnostics
+  desc: Functions to diagnose and fix common system issues
+  contents:
+  - diagnostic_test
+  - check_proxy_settings
+  - check_renv_download_method
+
 - title: Helpers
   desc: >
     Functions used in other functions across the package, exported as they can also