From c6fc73be2b8a1927f28fc30a261e911d40470d10 Mon Sep 17 00:00:00 2001
From: Nicolas Casajus <ahasverus@users.noreply.github.com>
Date: Sun, 31 Mar 2024 10:48:06 +0200
Subject: [PATCH] doc: update function examples

---
 R/get_calendar.R        |  4 ++--
 R/get_month_name.R      |  9 +++++++--
 R/get_weekday_name.R    | 11 +++++++++--
 man/get_calendar.Rd     |  4 ++--
 man/get_month_name.Rd   |  9 +++++++--
 man/get_weekday_name.Rd | 11 +++++++++--
 6 files changed, 36 insertions(+), 12 deletions(-)

diff --git a/R/get_calendar.R b/R/get_calendar.R
index dc03b3e..0ccafd6 100644
--- 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
index 9ddc88e..0ee1518 100644
--- 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
index a27d04b..2f859c2 100644
--- 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
index 0ee5a85..06e4def 100644
--- a/man/get_calendar.Rd
+++ b/man/get_calendar.Rd
@@ -56,6 +56,6 @@ head(get_calendar(month = 4))
 ## 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"))
 }
diff --git a/man/get_month_name.Rd b/man/get_month_name.Rd
index 2f1e98e..20b3e91 100644
--- a/man/get_month_name.Rd
+++ b/man/get_month_name.Rd
@@ -21,7 +21,12 @@ A \code{character} of length 1.
 Get the name of a month
 }
 \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")
 }
diff --git a/man/get_weekday_name.Rd b/man/get_weekday_name.Rd
index e5b1bc4..b8a90ea 100644
--- a/man/get_weekday_name.Rd
+++ b/man/get_weekday_name.Rd
@@ -25,8 +25,15 @@ A \code{character} of length 1.
 Get the weekday name of a date
 }
 \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")
 }