From 315d4b79d90976ec9cfd4fd4a927d447df65f68a Mon Sep 17 00:00:00 2001
From: Anton <dev@atjn.dk>
Date: Thu, 21 Mar 2024 11:29:02 +0100
Subject: [PATCH] Add better deprecation descriptions

---
 apps/locale/locale.html      |  2 +-
 typescript/types/locale.d.ts | 12 ++++++++++--
 2 files changed, 11 insertions(+), 3 deletions(-)

diff --git a/apps/locale/locale.html b/apps/locale/locale.html
index e75f8726f..5ebd299e1 100644
--- a/apps/locale/locale.html
+++ b/apps/locale/locale.html
@@ -209,7 +209,7 @@ exports = {
     }
     return s.substr(0, i + 3) + r + (d ? '${locale.decimal_point}' + d: '');
   },
-  currency: n => {console.log("Warning: Currency information is deprecated");return ${js("£")}+exports.number(n)},
+  currency: n => {console.log("Warning: Currency information is deprecated, see https://github.com/espruino/BangleApps/issues/3269");return ${js("£")}+exports.number(n)},
   distance: (n,dp) => n < ${distanceUnits[locale.distance[1]]} ? round(${unitConv(distanceUnits[locale.distance[0]])},dp) + ${js(locale.distance[0])} : round(${unitConv(distanceUnits[locale.distance[1]])},dp) + ${js(locale.distance[1])},
   speed: (n,dp) => round(${unitConv(speedUnits[locale.speed])},dp) + ${js(locale.speed)},
   temp: (t,dp) => round(${temperature},dp) + ${js(locale.temperature)},
diff --git a/typescript/types/locale.d.ts b/typescript/types/locale.d.ts
index 38b9f74a8..62d37d9dd 100644
--- a/typescript/types/locale.d.ts
+++ b/typescript/types/locale.d.ts
@@ -3,12 +3,20 @@ declare module Locale {
 
   type Locale = {
     name: string,
-    /** @deprecated */
+    /**
+     * @deprecated
+     * There was no use case for this variable.
+     * For more details, see https://github.com/espruino/BangleApps/issues/3269
+     */
     currencySym: string,
     dow(date: Date, short?: ShortBoolean): string,
     month(date: Date, short?: ShortBoolean): string,
     number(n: number): string,
-    /** @deprecated */
+    /**
+     * @deprecated
+     * There was no use case for this method.
+     * For more details, see https://github.com/espruino/BangleApps/issues/3269
+     */
     currency(c: number): string,
     distance(d: number): string,
     speed(s: number): string,