docs: add return docu

mlr-org · Oct 10, 2022 · 711f2e2 · 711f2e2
1 parent ff3e80a
commit 711f2e2
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 0 deletions.
diff --git a/R/autoplot.BenchmarkAggr.R b/R/autoplot.BenchmarkAggr.R
@@ -53,6 +53,9 @@
 #' @references
 #' `r format_bib("demsar_2006")`
 #'
+#' @return
+#' The generated plot.
+#'
 #' @examples
 #' if (requireNamespaces(c("mlr3learners", "mlr3", "rpart", "xgboost"))) {
 #' library(mlr3)

diff --git a/R/helpers.R b/R/helpers.R
@@ -15,6 +15,8 @@
 #' @title Helper Vectorizing requireNamespace
 #' @description Internal helper function for documentation.
 #' @param x Packages to check.
+#' @return
+#' A `logical(1)`, indicating wether all required packages are available.
 #' @export
 requireNamespaces = function(x) { # nolint
   if (all(map_lgl(x, requireNamespace, quietly = TRUE))) {

diff --git a/man/autoplot.BenchmarkAggr.Rd b/man/autoplot.BenchmarkAggr.Rd
diff --git a/man/requireNamespaces.Rd b/man/requireNamespaces.Rd