Skip to content

Commit

Permalink
Update jsdoc
Browse files Browse the repository at this point in the history
  • Loading branch information
veeck committed Oct 19, 2022
1 parent d51f155 commit a0488b8
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions modules/default/weather/weather.js
Original file line number Diff line number Diff line change
Expand Up @@ -202,10 +202,11 @@ Module.register("weather", {
},

/**
* Convert temp (from degrees C) if required
* Convert temp (from degrees C) if required into imperial or metric unit
* depending on your config
*
* @param {number} tempInC
* @returns {number}
* @param {number} tempInC the temperature you want to convert in celsius
* @returns {number} the temperature converted to what is defined in the config
*/
convertTemp(tempInC) {
return this.config.tempUnits === "imperial" ? this.roundValue(tempInC * 1.8 + 32) : tempInC;
Expand All @@ -230,8 +231,8 @@ Module.register("weather", {
/**
* Convert wind (from m/s) to beaufort scale
*
* @param {number} speedInMS
* @returns {number}
* @param {number} speedInMS ths windspeed you want to convert
* @returns {number} the speed in beaufort
*/
beaufortWindSpeed(speedInMS) {
const windInKmh = (speedInMS * 3600) / 1000;
Expand Down

0 comments on commit a0488b8

Please sign in to comment.