docs: closes #5

DESCRIPTION

@@ -38,6 +38,6 @@ License: GPL (>= 3)
 URL: https://standby.rsquaredacademy.com/, https://github.com/rsquaredacademy/standby
 BugReports: https://github.com/rsquaredacademy/standby/issues
 Encoding: UTF-8
-RoxygenNote: 7.1.1
+RoxygenNote: 7.3.2
 VignetteBuilder: knitr
 Config/testthat/edition: 3

R/alertify-handler.R

@@ -32,7 +32,7 @@
 #' \item \code{"top-center"}
 #' }
 #' @param transition_off Logical; if \code{TRUE}, transition effect is disabled. Defaults to \code{FALSE}.
-#' @param closable Logical; if \code{TRUE} (the default), a |code{Close} button is displayed in the header of the dialog.
+#' @param closable Logical; if \code{TRUE} (the default), a \code{Close} button is displayed in the header of the dialog.
 #' @param auto_reset Logical; if \code{TRUE} (the default), the dialog will reset size/position on window resize.
 #' @param frameless Logical; if \code{TRUE}, hides both header and footer of the dialog. Defaults to \code{FALSE}.
 #' @param maximizable Logical; if \code{TRUE} (the default), the \code{Maximize} button is displayed in the header of the dialog.
@@ -111,12 +111,14 @@ NULL
 #' @rdname alertify
 #' @export
 #'
-alertify_alert <- function(title = "Alert Title", message = "Alert Message", type = "success",
-                           btn_label = "OK", transition = "pulse", transition_off = FALSE,
-                           closable = TRUE, auto_reset = FALSE, frameless = FALSE,
-                           maximizable = FALSE, modal = FALSE, movable = FALSE, move_bounded = TRUE,
-                           overflow = FALSE, padding = TRUE, pinnable = FALSE, resizeable = FALSE,
-                           start_maximized = FALSE,
+alertify_alert <- function(title = "Alert Title", message = "Alert Message",
+                           type = "success", btn_label = "OK",
+                           transition = "pulse", transition_off = FALSE,
+                           closable = TRUE, auto_reset = FALSE,
+                           frameless = FALSE, maximizable = FALSE,
+                           modal = FALSE, movable = FALSE, move_bounded = TRUE,
+                           overflow = FALSE, padding = TRUE, pinnable = FALSE,
+                           resizeable = FALSE, start_maximized = FALSE,
                            session = getDefaultReactiveDomain()) {
 
   notice = list(
@@ -149,8 +151,8 @@ alertify_alert <- function(title = "Alert Title", message = "Alert Message", typ
 #' @rdname alertify
 #' @export
 #'
-alertify_notify <- function(message = "Alert Message", type = "success", delay = 5,
-                            position = "bottom-right",
+alertify_notify <- function(message = "Alert Message", type = "success",
+                            delay = 5, position = "bottom-right",
                             session = getDefaultReactiveDomain()) {
 
   notice = list(

R/pnotify-handler.R

@@ -12,7 +12,7 @@
 #' }
 #' @param icon Logical; if \code{TRUE} (the default), default icon is displayed. No icon is displayed if set to \code{FALSE}.
 #' @param delay Delay in milliseconds before the notice is removed. If set to \code{"infinity"}, the notice will not close.
-#' @param hide Logical; if \code{TRUE} (the default), notice is closed after |code{delay} specified in milliseconds.
+#' @param hide Logical; if \code{TRUE} (the default), notice is closed after \code{delay} specified in milliseconds.
 #' @param sticker Logical; if \code{TRUE} (the default), provides a button for the user to manually stick the notice.
 #' @param closer Logical; if \code{TRUE} (the default), provides a button for the user to manually close the notice.
 #' @param shadow Logical; if \code{TRUE} (the default), displays a drop shadow.
@@ -68,10 +68,12 @@
 #'
 #' @export
 #'
-notify <- function(title = "Hey", text = NULL, type = "notice", icon = TRUE, delay = 8000,
-                   hide = TRUE, sticker = TRUE, closer = TRUE, shadow = TRUE, mouse_reset = TRUE,
-                   animation = 'fade', animate_speed = 'normal', width = "360px", min_height = "16px",
-                   max_text_height = "200px", translucent = FALSE, non_blocking = FALSE,
+notify <- function(title = "Hey", text = NULL, type = "notice", icon = TRUE,
+                   delay = 8000, hide = TRUE, sticker = TRUE, closer = TRUE,
+                   shadow = TRUE, mouse_reset = TRUE, animation = 'fade',
+                   animate_speed = 'normal', width = "360px",
+                   min_height = "16px", max_text_height = "200px",
+                   translucent = FALSE, non_blocking = FALSE,
                    session = getDefaultReactiveDomain()) {
 
   notice = list(