update config.js.sample about locale variable (#3655)

add text to config.js.sample about usage of locale variable/property

Co-authored-by: Veeck <[email protected]>

Author: sdetweil

CHANGELOG.md

@@ -23,6 +23,7 @@ _This release is scheduled to be released on 2025-01-01._
 - [linter] Re-activate `eslint-plugin-package-json` to lint `package.json` (#3643)
 - [linter] Add linting for markdown files (#3646)
 - [calendar] Add ability to display end date for full date events, where end is not same day (showEnd=true) (#3650)
+- [core] Add text to the config.js.sample file about the locale variable (#3654)
 
 ### Changed
 

config/config.js.sample

@@ -28,7 +28,11 @@ let config = {
 	httpsCertificate: "",	// HTTPS Certificate path, only require when useHttps is true
 
 	language: "en",
-	locale: "en-US",
+	locale: "en-US",   // this variable is provided as a consistent location
+			   // it is currently only used by 3rd party modules. no MagicMirror code uses this value
+			   // as we have no usage, we  have no constraints on what this field holds
+			   // see https://en.wikipedia.org/wiki/Locale_(computer_software) for the possibilities
+
 	logLevel: ["INFO", "LOG", "WARN", "ERROR"], // Add "DEBUG" for even more logging
 	timeFormat: 24,
 	units: "metric",