doc: update function examples

FRBCesab · Mar 31, 2024 · c6fc73b · c6fc73b
1 parent 2badfe0
commit c6fc73b
Show file tree

Hide file tree

Showing 6 changed files with 36 additions and 12 deletions.
diff --git a/R/get_calendar.R b/R/get_calendar.R
@@ -40,8 +40,8 @@
 #' ## Calendar for January 1970 ----
 #' head(get_calendar(year = 1970, month = 1))
 #' 
-#' ## Change the locale ----
-#' head(get_calendar(year = 1970, month = 1, lang = "spanish"))
+#' ## Change the locale (Spanish) ----
+#' head(get_calendar(year = 1970, month = 1, lang = "es_SP"))
 
 get_calendar <- function(year = format(Sys.Date(), "%Y"), 
                          month = format(Sys.Date(), "%m"), weekend = FALSE,

diff --git a/R/get_month_name.R b/R/get_month_name.R
@@ -12,9 +12,14 @@
 #' @export
 #'
 #' @examples
+#' ## Default ----
 #' get_month_name(month = 4)
-#' get_month_name(month = 4, lang = "spanish")
-#' get_month_name(month = 4, lang = "finnish")
+#' 
+#' ## Get Spanish name ----
+#' get_month_name(month = 4, lang = "es_SP")
+#' 
+#' ## Get Finnish name ----
+#' get_month_name(month = 4, lang = "fi_FI")
 
 get_month_name <- function(month, lang = NULL) {
 

diff --git a/R/get_weekday_name.R b/R/get_weekday_name.R
@@ -16,10 +16,17 @@
 #' @export
 #'
 #' @examples
+#' ## Default ----
 #' get_weekday_name("2024-04-01")
+#' 
+#' ## Change date format ----
 #' get_weekday_name("01/04/2024", format = "%d/%m/%Y")
-#' get_weekday_name("2024-04-01", lang = "spanish")
-#' get_weekday_name("2024-04-01", lang = "finnish")
+#' 
+#' ## Get Spanish name ----
+#' get_weekday_name("2024-04-01", lang = "es_SP")
+#' 
+#' ## Get Finnish name ----
+#' get_weekday_name("2024-04-01", lang = "fi_FI")
 
 get_weekday_name <- function(date, format = "%Y-%m-%d", lang = NULL) {
 

diff --git a/man/get_calendar.Rd b/man/get_calendar.Rd
diff --git a/man/get_month_name.Rd b/man/get_month_name.Rd
diff --git a/man/get_weekday_name.Rd b/man/get_weekday_name.Rd