chore: update docs

insightsengineering · Oct 10, 2024 · 6468f33 · 6468f33
1 parent d8e3548
commit 6468f33
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 6 deletions.
diff --git a/R/toggleable_slider.R b/R/toggleable_slider.R
@@ -20,9 +20,6 @@
 #' @param step_numeric `numeric or integer` step for numeric input fields
 #' @param width `numeric` width of slider or of each numeric field
 #'
-#' @return Shiny HTML UI
-#' @keywords internal
-#'
 #' @examples
 #' value <- c(20.3, 81.5) # dichotomous slider
 #' # value <- c(50.1) # normal slider
@@ -59,6 +56,14 @@
 #' if (interactive()) {
 #'   shinyApp(ui, server)
 #' }
+#' @name toggle_sidebar
+#' @rdname toggle_sidebar
+#' @keywords internal
+#' @return `NULL`.
+NULL
+
+
+#' @rdname toggle_sidebar
 toggle_slider_ui <- function(id,
                              label,
                              min,
@@ -130,10 +135,11 @@ toggle_slider_ui <- function(id,
   )
 }
 
+#' @param is_dichotomous_slider `logical` whether it is a dichotomous slider or normal slider
 #' @param step_slider `numeric or integer` step for slider
 #' @param ... additional parameters to pass to `sliderInput`
 #' @keywords internal
-# is_dichotomous_slider `logical` whether it is a dichotomous slider or normal slider
+#' @rdname toggle_slider
 toggle_slider_server <- function(id, is_dichotomous_slider = TRUE, step_slider = NULL, ...) {
   moduleServer(id, function(input, output, session) {
     checkmate::assert_flag(is_dichotomous_slider)

diff --git a/man/toggle_slider_ui.Rd → man/toggle_sidebar.Rd b/man/toggle_slider_ui.Rd → man/toggle_sidebar.Rd