From 5997416e1b59afc494583fc29f1fc70c94f1e1b2 Mon Sep 17 00:00:00 2001
From: garronej <joseph.garrone.gj@gmail.com>
Date: Fri, 26 Aug 2022 15:43:32 +0700
Subject: [PATCH] Update i18n API JSDoc comments

---
 src/lib/i18n/index.tsx | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

diff --git a/src/lib/i18n/index.tsx b/src/lib/i18n/index.tsx
index f2e0f516..2d9d8bb2 100644
--- a/src/lib/i18n/index.tsx
+++ b/src/lib/i18n/index.tsx
@@ -27,12 +27,13 @@ export type I18n<MessageKey extends string = MessageKeyBase> = {
      */
     currentLanguageTag: string;
     /**
+     * To call when the user switch language.
      * This will cause the page to be reloaded,
      * on next load currentLanguageTag === newLanguageTag
      */
     changeLocale: (newLanguageTag: string) => never;
     /**
-     * e.g. "en" => "English", "fr" => "Français"
+     * e.g. "en" => "English", "fr" => "Français", ...
      *
      * Used to render a select that enable user to switch language.
      * ex: https://user-images.githubusercontent.com/6702424/186044799-38801eec-4e89-483b-81dd-8e9233e8c0eb.png
@@ -53,8 +54,8 @@ export type I18n<MessageKey extends string = MessageKeyBase> = {
     msgStr: (key: MessageKey, ...args: (string | undefined)[]) => string;
     /**
      * Examples assuming currentLanguageTag === "en"
-     * advancedMsg("${access-denied} foo bar") === msg("access-denied") + " foo bar" === <span>Access denied foo bar</span>
-     * advancedMsg("${access-denied}") === advancedMsg("access-denied") === msg("access-denied")
+     * advancedMsg("${access-denied} foo bar") === <span>${msgStr("access-denied")} foo bar<span> === <span>Access denied foo bar</span>
+     * advancedMsg("${access-denied}") === advancedMsg("access-denied") === msg("access-denied") === <span>Access denied</span>
      * advancedMsg("${not-a-message-key}") === advancedMsg(not-a-message-key") === <span>not-a-message-key</span>
      */
     advancedMsg: (key: string, ...args: (string | undefined)[]) => JSX.Element;