kenmirrors/MagicMirror
1
0
Fork 0
mirror of https://github.com/MichMich/MagicMirror.git synced 2025-06-28 12:12:20 +00:00
Code Issues Projects Releases Wiki Activity

Some spelling and doc fixes

Browse Source
This commit is contained in:
rejas 2020-04-22 22:07:03 +02:00
parent 0c60d54c3f
commit 14aa4036e0
7 changed files with 8 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
js/socket.js
View File

@ -1,5 +1,3 @@
/* exported Log */
/* Magic Mirror /* Magic Mirror
* Socket Connection * Socket Connection
* *

2
modules/default/weather/README.md
View File

@ -1,5 +1,5 @@
# Weather Module # Weather Module
This module is aimed to be the replacement for the current `currentweather` and `weatherforcast` modules. The module will be configurable to be used as a current weather view, or to show the forecast. This way the module can be used twice to fullfil both purposes. This module aims to be the replacement for the current `currentweather` and `weatherforcast` modules. The module will be configurable to be used as a current weather view, or to show the forecast. This way the module can be used twice to fullfil both purposes.
For configuration options, please check the [MagicMirror² documentation](https://docs.magicmirror.builders/modules/weather.html). For configuration options, please check the [MagicMirror² documentation](https://docs.magicmirror.builders/modules/weather.html).

4
modules/default/weather/providers/README.md
View File

@ -13,7 +13,7 @@ Table of Contents:
## The weather provider file: yourprovider.js ## The weather provider file: yourprovider.js
This is the script in which the weather provider will be defined. In it's most simple form, the weather provider must implement the following: This is the script in which the weather provider will be defined. In its most simple form, the weather provider must implement the following:
````javascript ````javascript
WeatherProvider.register("yourprovider", { WeatherProvider.register("yourprovider", {
@ -36,7 +36,7 @@ It will then automatically refresh the module DOM with the new data.
#### `fetchWeatherForecast()` #### `fetchWeatherForecast()`
This method is called when the weather module tries to fetch the weather weather of your provider. The implementation of this method is required. This method is called when the weather module tries to fetch the weather of your provider. The implementation of this method is required.
The implementation can make use of the already implemented function `this.fetchData(url, method, data);`, which is returning a promise. The implementation can make use of the already implemented function `this.fetchData(url, method, data);`, which is returning a promise.
After the response is processed, the weather forecast information (as an array of [WeatherObject](#weatherobject)s) needs to be set with `this.setCurrentWeather(forecast);`. After the response is processed, the weather forecast information (as an array of [WeatherObject](#weatherobject)s) needs to be set with `this.setCurrentWeather(forecast);`.
It will then automatically refresh the module DOM with the new data. It will then automatically refresh the module DOM with the new data.

4
modules/default/weatherforecast/weatherforecast.js
View File

@ -61,7 +61,7 @@ Module.register("weatherforecast",{
}, },
}, },
// create a variable for the first upcoming calendaar event. Used if no location is specified. // create a variable for the first upcoming calendar event. Used if no location is specified.
firstEvent: false, firstEvent: false,
// create a variable to hold the location name based on the API result. // create a variable to hold the location name based on the API result.
@ -309,7 +309,7 @@ Module.register("weatherforecast",{
* parserDataWeather(data) * parserDataWeather(data)
* *
* Use the parse to keep the same struct between daily and forecast Endpoint * Use the parse to keep the same struct between daily and forecast Endpoint
* from Openweather * from openweather.org
* *
*/ */
parserDataWeather: function(data) { parserDataWeather: function(data) {

2
tests/configs/modules/calendar/old-basic-auth.js
View File

@ -1,5 +1,5 @@
/* Magic Mirror Test config default calendar /* Magic Mirror Test config default calendar
* with authenticacion old config * with authentication old config
* By Rodrigo Ramírez Norambuena https://rodrigoramirez.com * By Rodrigo Ramírez Norambuena https://rodrigoramirez.com
* MIT Licensed. * MIT Licensed.
*/ */

5
tests/configs/modules/clock/es/clock_showWeek.js
View File

@ -1,7 +1,4 @@
/* Magic Mirror Test config for default clock module
/* Magic Mirror
*
* Test config for default clock module
* Language es for showWeek feature * Language es for showWeek feature
* *
* By Rodrigo Ramírez Norambuena * By Rodrigo Ramírez Norambuena

4
tests/configs/modules/helloworld/helloworld_default.js
View File

@ -1,6 +1,4 @@
/* Magic Mirror /* Magic Mirror Test config sample module hello world default config
*
* Test config sample module hello world default config
* *
* By Rodrigo Ramírez Norambuena https://rodrigoramirez.com * By Rodrigo Ramírez Norambuena https://rodrigoramirez.com
* MIT Licensed. * MIT Licensed.