From f0ed987010f9f6e91d3954beab67d73fa51ed2aa Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Va=CC=81clav=20Slavi=CC=81k?= <vaclav@slavik.io>
Date: Mon, 12 Feb 2024 14:31:16 +0100
Subject: [PATCH] Warn about a GetBestAvailableTranslation() quirk

---
 interface/wx/translation.h | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/interface/wx/translation.h b/interface/wx/translation.h
index cba3f1fdad..bfecf3d24f 100644
--- a/interface/wx/translation.h
+++ b/interface/wx/translation.h
@@ -97,6 +97,12 @@ public:
         it simply returns the language set with SetLanguage() if it's available
         or empty string otherwise.
 
+        @warning
+        This function does not consider messages ID language (typically
+        English) and can return inappropriate language if it is anywhere in
+        user's preferred languages list. Use GetBestTranslation() instead
+        unless you have very specific needs.
+
         @since 3.3.0
      */
     wxString GetBestAvailableTranslation(const wxString& domain);