Add better documentation on timeInput return type (#14)

burgerga · Aug 10, 2022 · 20e526a · 20e526a
1 parent 4ea4907
commit 20e526a
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 2 deletions.
diff --git a/NEWS.md b/NEWS.md
@@ -2,6 +2,7 @@
 
 - Replaced outdated shiny utils label functions (#16)
 - Added correct timezone handling to roundTime function (#11)
+- Add information on timeInput return type (#14)
 
 # shinyTime 1.0.1
 

diff --git a/R/input-time.R b/R/input-time.R
@@ -12,7 +12,11 @@
 #' @inheritParams shiny::textInput
 #' @param value The desired time value. Must be a instance of \code{\link{DateTimeClasses}}.
 #' @param seconds Show input for seconds. Defaults to TRUE.
-#' @param minute.steps Round time to multiples of \code{minute.steps} (should be a whole number). If not NULL sets \code{seconds} to \code{FALSE}.
+#' @param minute.steps Round time to multiples of \code{minute.steps} (should be a whole number).
+#' If not NULL sets \code{seconds} to \code{FALSE}.
+#'
+#' @returns timeInput returns a \code{POSIXlt} object, which can be converted to
+#' a \code{POSIXct} object with \code{as.POSIXct} for more efficient storage.
 #'
 #' @family shinyTime functions
 #' @seealso \code{\link{strptime}}, \code{\link{strftime}}, \code{\link{DateTimeClasses}}

diff --git a/man/timeInput.Rd b/man/timeInput.Rd