doc

Author: s-fleck

R/Appender.R

@@ -205,7 +205,7 @@ AppenderConsole <- R6::R6Class(
 #'
 #' \describe{
 #'   \item{`file`, `set_file(file)`}{`character` scalar. Path to the desired log
-#'   file. If the file does not exist it will be created}
+#'   file. If the file does not exist it will be created.}
 #'  }
 #'
 #'

R/Filter.R

@@ -41,15 +41,18 @@
 #'
 #' @examples
 #' # using filters to modify log events
+#' lg <- get_logger("test")
+#'
 #' analyse <- function(){
-#'   lgr$add_filter(FilterForceLevel$new("info"), "force")
-#'   lgr$add_filter(FilterInject$new(type = "analysis"), "inject")
-#'   on.exit(lgr$remove_filter(c("force", "inject")))
-#'   lgr$debug("a debug message")
-#'   lgr$error("an error")
+#'   lg$add_filter(FilterForceLevel$new("info"), "force")
+#'   lg$add_filter(FilterInject$new(type = "analysis"), "inject")
+#'   on.exit(lg$remove_filter(c("force", "inject")))
+#'   lg$debug("a debug message")
+#'   lg$error("an error")
 #' }
 #' analyse()
-#' lgr$error("an error")
+#' lg$error("an error")
+#' lg$config(NULL)  # reset config
 #'
 #'
 #' # using .obj()

R/Logger.R

@@ -214,8 +214,7 @@
 #' cat(readLines(tf2), sep = "\n")
 #'
 #' # cleanup
-#' unlink(tf)
-#' unlink(tf2)
+#' unlink(c(tf, tf2))
 #' lg$config(NULL)  # reset logger config
 #'
 #' # LoggerGlue
@@ -253,6 +252,7 @@
 #'   propagate = FALSE,
 #'   appenders = list(AppenderConsole$new(threshold = "info"))
 #' ))
+#'
 #' lg$config(NULL)  # resets logger to unconfigured state
 #'
 #' # Via YAML

R/simple_logging.R

@@ -37,12 +37,6 @@ NULL
 #'
 #' @return the `root` Logger (lgr)
 #' @export
-#'
-#' @examples
-#' \dontrun{
-#' # make the root logger log to a file
-#'   basic_config(file = tempfile())
-#' }
 basic_config <- function(
   file = NULL,
   fmt = "%L [%t] %m",