Upgrade docs

DESCRIPTION

@@ -36,5 +36,4 @@ Config/testthat/edition: 3
 Encoding: UTF-8
 Language: en-US
 Roxygen: list(markdown = TRUE)
-Config/roxygen2/version: 8.0.0
-RoxygenNote: 7.3.3
+Config/roxygen2/version: 8.1.0

NAMESPACE

@@ -10,15 +10,23 @@ importFrom(S7,convert)
 importFrom(callr,r)
 importFrom(grDevices,grSoftVersion)
 importFrom(methods,is)
-importFrom(quarto,quarto_render)
-importFrom(quarto,quarto_version)
-importFrom(tools,check_packages_in_dir_details)
-importFrom(tools,file_ext)
-importFrom(utils,capture.output)
-importFrom(utils,head)
-importFrom(utils,packageName)
-importFrom(utils,sessionInfo)
-importFrom(utils,tail)
-importFrom(val.meter,metrics)
-importFrom(val.meter,pkg)
+importFrom(quarto,
+  quarto_render,
+  quarto_version
+)
+importFrom(tools,
+  check_packages_in_dir_details,
+  file_ext
+)
+importFrom(utils,
+  capture.output,
+  head,
+  packageName,
+  sessionInfo,
+  tail
+)
+importFrom(val.meter,
+  metrics,
+  pkg
+)
 importFrom(yaml,yaml.load)

R/reporter.R

@@ -23,7 +23,7 @@
 #' @param quiet `logical(1L)` flag indicating whether output should be emitted
 #'   to the console when rendering the report.
 #' @param ... Additional arguments passed to [quarto::quarto_render()]
-#'
+#' @returns Path to the reports.
 #' @examples
 #' \dontrun{
 #' options(

R/session.R

@@ -4,7 +4,12 @@
 #'
 #' @importFrom grDevices grSoftVersion
 #' @importFrom utils sessionInfo
+#' @returns A list with time, r_version, session_info, platform, machine,
+#' rng_kind, capabilities, external_software and graphics_software information.
 #' @export
+#' @examples
+#' s <- session()
+#' str(s, 2)
 session <- function() {
   # NOTE: data that is provided as named character vectors are coerced to
   # lists because the names otherwise get lost when passed as a quarto parameter

R/utils-knitr.R

@@ -210,6 +210,8 @@ knit_print.knitr_log <- local({
 #'   be printed, mark them as "AsIs" using [I()].
 #'
 #' @export
+#' @examples
+#' knitr_logger()
 knitr_logger <- local({
   first_chunk_log <- TRUE
   style <- knitr_logger_styles

inst/WORDLIST

@@ -1,7 +1,12 @@
+AsIs
+CMD
 Codecov
-Hoffmann
 ORCID
 Revilla
-Vectorize
-funder
+Submodules
+knitr
+pre
 riskmetric
+rng
+serializable
+submodule