Skip to content

Commit 4dd70ef

Browse files
authored
Improved JSDoc comments
1 parent 34f0ba9 commit 4dd70ef

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

app/engine/utils/WLSLinearSeries.js

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
'use strict'
22
/**
33
* @copyright [OpenRowingMonitor]{@link https://github.com/JaapvanEkris/openrowingmonitor}
4-
*
4+
*
55
* @file The WLSLinearSeries is a datatype that represents a Linear Series. It allows
66
* values to be retrieved (like a FiFo buffer, or Queue) but it also includes
77
* a Weighted Linear Regressor to determine the slope, intercept and R^2 of this series
@@ -147,6 +147,9 @@ export function createWLSLinearSeries (maxSeriesLength = 0) {
147147
return (X.length() >= 2 && _slope !== 0)
148148
}
149149

150+
/**
151+
* @description This function is used for clearing all data, typically when flywheel.js is completely reset
152+
*/
150153
function reset () {
151154
X.reset()
152155
Y.reset()

0 commit comments

Comments
 (0)