Fixes #475 - Documentation edits-decluttering the top of the refs page

R/initial_split.R

@@ -6,7 +6,9 @@
 #'  `group_initial_split` creates splits of the data based
 #'  on some grouping variable, so that all data in a "group" is assigned to
 #'  the same split.
-#'  `training` and `testing` are used to extract the resulting data.
+#'
+#' @details `training` and `testing` are used to extract the resulting data.
+#'
 #' @template strata_details
 #' @inheritParams vfold_cv
 #' @inheritParams make_strata
@@ -176,12 +178,12 @@ group_initial_split <- function(data, group, prop = 3 / 4, ..., strata = NULL, p
   attrib <- .get_split_args(res, allow_strata_false = TRUE)
 
   res <- res$splits[[1]]
-  
+
   attrib$times <- NULL
   for (i in names(attrib)) {
     attr(res, i) <- attrib[[i]]
   }
   class(res) <- c("group_initial_split", "initial_split", class(res))
-  
+
   res
 }

R/initial_validation_split.R

@@ -8,7 +8,8 @@
 #' `group_initial_validation_split()` creates similar random splits of the data
 #' based on some grouping variable, so that all data in a "group" are assigned
 #' to the same partition.
-#' `training()`, `validation()`, and `testing()` can be used to extract the
+#'
+#' @details `training()`, `validation()`, and `testing()` can be used to extract the
 #' resulting data sets.
 #' Use [`validation_set()`] to create an `rset` object for use with functions from
 #' the tune package such as `tune::tune_grid()`.

R/validation_set.R

@@ -1,5 +1,7 @@
 #' Create a Validation Split for Tuning
 #'
+#' `validation_set` creates a the validation split for model tuning.
+#'
 #' @param split An object of class `initial_validation_split`, such as resulting
 #' from [initial_validation_split()] or [group_initial_validation_split()].
 #' @param x An `rsplit` object produced by `validation_set()`.