479 improve documentation

R/teal_slice.R

@@ -78,9 +78,7 @@
 #' @return A `teal.slice` object. Depending on whether `varname` or `expr` was specified, the resulting
 #' `teal_slice` also receives class `teal_slice_var` or `teal_slice_expr`, respectively.
 #'
-#' @note When `teal_slice` is printed and contains a `POSIX*t` class in `selected` or `choices` fields, then those
-#' fields are converted to `UTC` timezone, for enhanced and unified storage and restoring with `teal::slices_store()`
-#' and `teal::slices_restore()`.
+#' @note Date time objects of `POSIX*t` classes are printed as strings after converting to UTC timezone.
 #'
 #' @examples
 #' x1 <- teal_slice(

R/teal_slices.R

@@ -30,9 +30,9 @@
 #' @param i (`character` or `numeric` or `logical`) indicating which elements to extract
 #' @param recursive (`logical(1)`) flag specifying whether to also convert to list the elements of this `teal_slices`
 #'
-#' @note When `teal_slices` are printed and any of `teal_slice` elements contain a `POSIX*t` class in `selected` or
-#' `choices` fields, then those fields are converted to `UTC` timezone, for enhanced and unified storage and restoring
-#' with `teal::slices_store()` and `teal::slices_restore()`.
+#' @note
+#' The `teal` package contains robust utilities for saving and loading `teal_slices` in `JSON` format.
+#' See [`teal::slices_store`] and [`teal::slices_restore`].
 #'
 #' @return
 #' `teal_slices`, which is an unnamed list of `teal_slice` objects.
@@ -255,7 +255,12 @@ setdiff_teal_slices <- function(x, y) {
 }
 
 
-#' @rdname teal_slices
+#' Convert nested list to `teal_slices`.
+#'
+#' Helper function for converting old style filter specification (nested list) to the new one (`teal_slices`).
+#'
+#' This function is used internally during deprecation of the old filter panel.
+#'
 #' @export
 #' @keywords internal
 #'
@@ -343,7 +348,7 @@ list_to_teal_slices <- function(x) { # nolint
 #'
 #' This function is used internally in `c.teal_slices` to manage `teal_slices` attributes.
 #'
-#' @param `list`, either of atomic vectors or of `named list`s
+#' @param x `list`, either of atomic vectors or of `named list`s
 #' @return
 #' Either an atomic vector of length 1 or a (potentially nested) list.
 #'

inst/WORDLIST

@@ -1,11 +1,11 @@
+cloneable
 Forkers
+funder
 Hoffmann
 MultiAssayExperiment
-UI
-cloneable
-funder
 programmatically
 repo
 reproducibility
 subclasses
 subtype
+UI