From f8659b7466dd96d3300a5a0c0dba0949e51f3a41 Mon Sep 17 00:00:00 2001 From: Nicolas Casajus Date: Sun, 31 Mar 2024 10:56:58 +0200 Subject: [PATCH] doc: update function examples --- R/get_calendar.R | 4 +++- R/get_month_name.R | 6 ++++-- R/get_weekday_name.R | 6 ++++-- man/get_calendar.Rd | 4 +++- man/get_month_name.Rd | 6 ++++-- man/get_weekday_name.Rd | 6 ++++-- 6 files changed, 22 insertions(+), 10 deletions(-) diff --git a/R/get_calendar.R b/R/get_calendar.R index 0ccafd6..940b121 100644 --- a/R/get_calendar.R +++ b/R/get_calendar.R @@ -40,8 +40,10 @@ #' ## Calendar for January 1970 ---- #' head(get_calendar(year = 1970, month = 1)) #' +#' \dontrun{ #' ## Change the locale (Spanish) ---- -#' head(get_calendar(year = 1970, month = 1, lang = "es_SP")) +#' head(get_calendar(year = 1970, month = 1, lang = "Spanish")) +#' } 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 index 0ee1518..2a9d7b5 100644 --- a/R/get_month_name.R +++ b/R/get_month_name.R @@ -15,11 +15,13 @@ #' ## Default ---- #' get_month_name(month = 4) #' +#' \dontrun{ #' ## Get Spanish name ---- -#' get_month_name(month = 4, lang = "es_SP") +#' get_month_name(month = 4, lang = "Spanish") #' #' ## Get Finnish name ---- -#' get_month_name(month = 4, lang = "fi_FI") +#' get_month_name(month = 4, lang = "Finnish") +#' } get_month_name <- function(month, lang = NULL) { diff --git a/R/get_weekday_name.R b/R/get_weekday_name.R index 2f859c2..44dcb79 100644 --- a/R/get_weekday_name.R +++ b/R/get_weekday_name.R @@ -22,11 +22,13 @@ #' ## Change date format ---- #' get_weekday_name("01/04/2024", format = "%d/%m/%Y") #' +#' \dontrun{ #' ## Get Spanish name ---- -#' get_weekday_name("2024-04-01", lang = "es_SP") +#' get_weekday_name("2024-04-01", lang = "Spanish") #' #' ## Get Finnish name ---- -#' get_weekday_name("2024-04-01", lang = "fi_FI") +#' get_weekday_name("2024-04-01", lang = "Finnish") +#' } get_weekday_name <- function(date, format = "%Y-%m-%d", lang = NULL) { diff --git a/man/get_calendar.Rd b/man/get_calendar.Rd index 06e4def..b78f9a9 100644 --- a/man/get_calendar.Rd +++ b/man/get_calendar.Rd @@ -56,6 +56,8 @@ head(get_calendar(month = 4)) ## Calendar for January 1970 ---- head(get_calendar(year = 1970, month = 1)) +\dontrun{ ## Change the locale (Spanish) ---- -head(get_calendar(year = 1970, month = 1, lang = "es_SP")) +head(get_calendar(year = 1970, month = 1, lang = "Spanish")) +} } diff --git a/man/get_month_name.Rd b/man/get_month_name.Rd index 20b3e91..482461c 100644 --- a/man/get_month_name.Rd +++ b/man/get_month_name.Rd @@ -24,9 +24,11 @@ Get the name of a month ## Default ---- get_month_name(month = 4) +\dontrun{ ## Get Spanish name ---- -get_month_name(month = 4, lang = "es_SP") +get_month_name(month = 4, lang = "Spanish") ## Get Finnish name ---- -get_month_name(month = 4, lang = "fi_FI") +get_month_name(month = 4, lang = "Finnish") +} } diff --git a/man/get_weekday_name.Rd b/man/get_weekday_name.Rd index b8a90ea..4169f0b 100644 --- a/man/get_weekday_name.Rd +++ b/man/get_weekday_name.Rd @@ -31,9 +31,11 @@ get_weekday_name("2024-04-01") ## Change date format ---- get_weekday_name("01/04/2024", format = "\%d/\%m/\%Y") +\dontrun{ ## Get Spanish name ---- -get_weekday_name("2024-04-01", lang = "es_SP") +get_weekday_name("2024-04-01", lang = "Spanish") ## Get Finnish name ---- -get_weekday_name("2024-04-01", lang = "fi_FI") +get_weekday_name("2024-04-01", lang = "Finnish") +} }