From f797e1c0782a477cc8c0e9997aa5add6172ea9a0 Mon Sep 17 00:00:00 2001
From: bruvzg <7645683+bruvzg@users.noreply.github.com>
Date: Sat, 25 Jul 2020 23:42:11 +0300
Subject: Improve `OS::get_locale()` on macOS and Windows, replace "-" with "_"
 and use system macros instead of bitwise AND. Add locale format info to the
 documentation.

---
 doc/classes/OS.xml | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)

(limited to 'doc/classes')

diff --git a/doc/classes/OS.xml b/doc/classes/OS.xml
index 26110df335..a2ec342c81 100644
--- a/doc/classes/OS.xml
+++ b/doc/classes/OS.xml
@@ -201,7 +201,12 @@
 			<return type="String">
 			</return>
 			<description>
-				Returns the host OS locale.
+				Returns the host OS locale as a string of the form [code]language_Script_COUNTRY_VARIANT@extra[/code].
+				[code]language[/code] - 2 or 3 letter [url=https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes]language code[/url], in lower case.
+				[code]Script[/code] - optional, 4 letter [url=https://en.wikipedia.org/wiki/ISO_15924]script code[/url], in title case.
+				[code]COUNTRY[/code] - optional, 2 or 3 letter [url=https://en.wikipedia.org/wiki/ISO_3166-1]country code[/url], in upper case.
+				[code]VARIANT[/code] - optional, language variant, region and sort order. Variant can have any number of underscored key words.
+				[code]extra[/code] - optional, semicolon separated list of additional key words. Currency, calendar, sort order and numbering system information.
 			</description>
 		</method>
 		<method name="get_model_name" qualifiers="const">
-- 
cgit v1.2.3