From 15e8d33f73dd8b9f59a7ec5271e1c4cac68a439e Mon Sep 17 00:00:00 2001 From: Jordan Welch Date: Wed, 15 Oct 2025 19:47:38 -0500 Subject: [PATCH 1/6] "Subclass" -> "Override" --- js/module.js | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/js/module.js b/js/module.js index cfc1d1ef80..7c2cc4a8b0 100644 --- a/js/module.js +++ b/js/module.js @@ -7,9 +7,9 @@ const Module = Class.extend({ /** - ******************************************************** - * All methods (and properties) below can be subclassed. * - ******************************************************** + ******************************************************* + * All methods (and properties) below can be extended. * + ******************************************************* */ // Set the minimum MagicMirror² module version for this module. @@ -76,8 +76,8 @@ const Module = Class.extend({ /** * Generates the dom which needs to be displayed. This method is called by the MagicMirror² core. - * This method can to be subclassed if the module wants to display info on the mirror. - * Alternatively, the getTemplate method could be subclassed. + * This method can to be overridden if the module wants to display info on the mirror. + * Alternatively, the getTemplate method could be overridden. * @returns {HTMLElement|Promise} The dom or a promise with the dom to display. */ getDom () { @@ -110,7 +110,7 @@ const Module = Class.extend({ /** * Generates the header string which needs to be displayed if a user has a header configured for this module. * This method is called by the MagicMirror² core, but only if the user has configured a default header for the module. - * This method needs to be subclassed if the module wants to display modified headers on the mirror. + * This method needs to be overridden if the module wants to display modified headers on the mirror. * @returns {string} The header to display above the header. */ getHeader () { @@ -119,8 +119,8 @@ const Module = Class.extend({ /** * Returns the template for the module which is used by the default getDom implementation. - * This method needs to be subclassed if the module wants to use a template. - * It can either return a template sting, or a template filename. + * This method needs to be overridden if the module wants to use a template. + * It can either return a template string, or a template filename. * If the string ends with '.html' it's considered a file from within the module's folder. * @returns {string} The template string of filename. */ @@ -130,7 +130,7 @@ const Module = Class.extend({ /** * Returns the data to be used in the template. - * This method needs to be subclassed if the module wants to use a custom data. + * This method needs to be overridden if the module wants to use a custom data. * @returns {object} The data for the template */ getTemplateData () { @@ -197,9 +197,9 @@ const Module = Class.extend({ }, /** - ******************************************** - * The methods below don't need subclassing. * - ******************************************** + ********************************************* + * The methods below should not be extended. * + ********************************************* */ /** From f5f81fae321d3af13fe6bb01ccd110994f66e18f Mon Sep 17 00:00:00 2001 From: Jordan Welch Date: Wed, 15 Oct 2025 19:47:55 -0500 Subject: [PATCH 2/6] Remove "subclassing" from CSPell --- cspell.config.json | 1 - 1 file changed, 1 deletion(-) diff --git a/cspell.config.json b/cspell.config.json index 35442b2ffb..a914dbf2e0 100644 --- a/cspell.config.json +++ b/cspell.config.json @@ -207,7 +207,6 @@ "sthuber", "Stieber", "stylelintrc", - "subclassing", "sunaction", "suncalc", "suntimes", From 3c540d374a94e147132cc3c1f429dd3f4ea68af1 Mon Sep 17 00:00:00 2001 From: Jordan Welch Date: Wed, 15 Oct 2025 19:48:41 -0500 Subject: [PATCH 3/6] Update "subclass" in warning messages --- modules/default/weather/weatherprovider.js | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/modules/default/weather/weatherprovider.js b/modules/default/weather/weatherprovider.js index 0fa24a69b0..27be7f8f32 100644 --- a/modules/default/weather/weatherprovider.js +++ b/modules/default/weather/weatherprovider.js @@ -42,19 +42,19 @@ const WeatherProvider = Class.extend({ // This method should start the API request to fetch the current weather. // This method should definitely be overwritten in the provider. fetchCurrentWeather () { - Log.warn(`Weather provider: ${this.providerName} does not subclass the fetchCurrentWeather method.`); + Log.warn(`Weather provider: ${this.providerName} does not override the fetchCurrentWeather method.`); }, // This method should start the API request to fetch the weather forecast. // This method should definitely be overwritten in the provider. fetchWeatherForecast () { - Log.warn(`Weather provider: ${this.providerName} does not subclass the fetchWeatherForecast method.`); + Log.warn(`Weather provider: ${this.providerName} does not override the fetchWeatherForecast method.`); }, // This method should start the API request to fetch the weather hourly. // This method should definitely be overwritten in the provider. fetchWeatherHourly () { - Log.warn(`Weather provider: ${this.providerName} does not subclass the fetchWeatherHourly method.`); + Log.warn(`Weather provider: ${this.providerName} does not override the fetchWeatherHourly method.`); }, // This returns a WeatherDay object for the current weather. From 517f24e5da2e799b9b7664cfb0b9747ffcb8d8b1 Mon Sep 17 00:00:00 2001 From: Jordan Welch Date: Wed, 15 Oct 2025 20:03:59 -0500 Subject: [PATCH 4/6] Add warning update to changelog --- CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 037da15e3e..e235fdda1d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -58,6 +58,7 @@ Thanks to: @Crazylegstoo, @dathbe, @m-idler, @plebcity, @khassel, @KristjanESPER - Improve test reliability and maintainability - [tests] add alert module tests for different welcome_message configurations (#3867) - [lint-staged] use `prettier --write --ignore-unknown` in `lint-staged` to avoid errors on unsupported files (#3888) +- [weatherprovider] update override warning wording (#3914) ### Updated From b7d9ada69e772c0563884a66b40052e0dac0a5a5 Mon Sep 17 00:00:00 2001 From: Jordan Welch Date: Thu, 16 Oct 2025 07:45:26 -0500 Subject: [PATCH 5/6] `extended` -> `overridden` --- js/module.js | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/js/module.js b/js/module.js index 7c2cc4a8b0..0f5465d0ad 100644 --- a/js/module.js +++ b/js/module.js @@ -7,9 +7,9 @@ const Module = Class.extend({ /** - ******************************************************* - * All methods (and properties) below can be extended. * - ******************************************************* + ********************************************************* + * All methods (and properties) below can be overridden. * + ********************************************************* */ // Set the minimum MagicMirror² module version for this module. @@ -197,9 +197,9 @@ const Module = Class.extend({ }, /** - ********************************************* - * The methods below should not be extended. * - ********************************************* + *********************************************** + * The methods below should not be overridden. * + *********************************************** */ /** From a9096031a41d085ecbc310fb2468fc577017cac2 Mon Sep 17 00:00:00 2001 From: Kristjan ESPERANTO <35647502+KristjanESPERANTO@users.noreply.github.com> Date: Mon, 3 Nov 2025 19:55:37 +0100 Subject: [PATCH 6/6] docs: move entry to the right release --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 9b2f18ab6b..9785d54d3b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -23,6 +23,7 @@ planned for 2026-01-01 - [calendar] test: remove "Recurring event per timezone" test (#3929) - [calendar] chore: remove `requiresVersion: "2.1.0"` (#3932) - [tests] migrate from `jest` to `vitest` (#3940) +- [weatherprovider] update override warning wording (#3914) ### Fixed @@ -69,7 +70,6 @@ Thanks to: @Crazylegstoo, @dathbe, @m-idler, @plebcity, @khassel, @KristjanESPER - Improve test reliability and maintainability - [tests] add alert module tests for different welcome_message configurations (#3867) - [lint-staged] use `prettier --write --ignore-unknown` in `lint-staged` to avoid errors on unsupported files (#3888) -- [weatherprovider] update override warning wording (#3914) ### Updated