Pre-release activities (prepare for CRAN release)

R/Queue.R

@@ -1,15 +1,20 @@
 # Queue ====
 
-#' @title R6 Class - A First-In-First-Out Abstract Data Type
+#' R6 Class - A First-In-First-Out Abstract Data Type
+#' @docType class
+#'
+#' @description
+#' `r lifecycle::badge("experimental")`
 #'
-#' @description `r lifecycle::badge("experimental")`\cr
 #' Abstract data type that stores and returns any number of elements.
 #'
+#' @details
 #' A `Queue` object stores all elements in a single vector,
 #' thus all data types can be stored, but silent coercion may occur.
 #'
 #' Elements are returned in the same order that they were added.
 #'
+#' @name Queue
 #' @keywords internal
 #'
 Queue <- R6::R6Class( # nolint
@@ -19,9 +24,9 @@ Queue <- R6::R6Class( # nolint
     #' @description
     #' Adds element(s) to `Queue`.
     #'
-    #' @param new_elements vector of elements to add
+    #' @param new_elements vector of elements to add.
     #'
-    #' @return self invisibly
+    #' @return `self`, invisibly.
     #'
     push = function(new_elements) {
       for (i in seq_along(new_elements)) {
@@ -34,16 +39,16 @@ Queue <- R6::R6Class( # nolint
     #' @description
     #' Returns all contents of the `Queue` object.
     #'
-    #' @return single vector containing all `Queue` contents
+    #' @return Single vector containing all `Queue` contents.
     #'
     get = function() {
       private$array
     },
     #' @description
     #' Returns the first (oldest) element of the `Queue` and removes it.
     #'
-    #' @return
-    #' vector of length 1 containing the first element of `Queue` or NULL if `Queue` is empty
+    #' @return vector of length 1 containing the first element of `Queue`
+    #' or `NULL` if `Queue` is empty.
     #'
     pop = function() {
       returned_element <- self$get()[1L]
@@ -54,9 +59,9 @@ Queue <- R6::R6Class( # nolint
     #' Removes the oldest occurrence of specified element(s) from `Queue`.
     #' Relies on implicit type conversions of R identify elements to remove.
     #'
-    #' @param elements vector of elements to remove from `Queue`
+    #' @param elements vector of elements to remove from `Queue`.
     #'
-    #' @return self invisibly
+    #' @return `self`, invisibly.
     #'
     remove = function(elements) {
       for (el in elements) {
@@ -68,7 +73,7 @@ Queue <- R6::R6Class( # nolint
     #' @description
     #' Removes all elements from `Queue`.
     #'
-    #' @return self invisibly
+    #' @return `self`, invisibly.
     #'
     empty = function() {
       private$array <- c()
@@ -77,17 +82,17 @@ Queue <- R6::R6Class( # nolint
     #' @description
     #' Returns the number of elements in `Queue`.
     #'
-    #' @return integer of length 1
+    #' @return `integer(1)`.
     #'
     size = function() {
       length(self$get())
     },
     #' @description
     #' Prints this `Queue`.
     #'
-    #' @param ... additional arguments to this method, ignored
+    #' @param ... Additional arguments to this method, ignored.
     #'
-    #' @return invisibly self
+    #' @return `self`, invisibly.
     print = function(...) {
       cat(
         sprintf(

R/all_choices.R

@@ -1,9 +1,12 @@
-#' An S3 structure representing the selection of all
-#' possible choices in a `filter_spec`, `select_spec` or `choices_selected` object.
+#' Bare constructor for `all_choices` object
 #'
-#' @description `r lifecycle::badge("experimental")`
+#' @description
+#' `r lifecycle::badge("experimental")`
 #'
-#' @return `all_choices` object
+#' An S3 structure representing the selection of all possible choices in a
+#' `filter_spec`, `select_spec` or `choices_selected` object
+#'
+#' @return `all_choices` object.
 #'
 #' @examples
 #' # Both structures are semantically identical
@@ -22,6 +25,7 @@
 #' choices_selected(choices = letters, selected = letters)
 #' choices_selected(choices = letters, selected = all_choices())
 #' @export
+#'
 all_choices <- function() {
   structure(list(), class = "all_choices")
 }