Skip to content

Commit 432ad5f

Browse files
authored
chore: remove boundaries from docstring. (#21)
* chore: remove boundaries from docstring. - this option was removed in 401d16c * chore: remove boundaries also from README.md
1 parent 4c52a55 commit 432ad5f

File tree

2 files changed

+0
-5
lines changed

2 files changed

+0
-5
lines changed

README.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -43,10 +43,6 @@ Savitzky-Golay parameters. windowSize should be odd; polynomial is the degree of
4343

4444
Factor to multiply the calculated height (usually 2).
4545

46-
#### boundaries=false
47-
48-
Return also the inflection points of the peaks
49-
5046
#### derivativeThreshold=0
5147

5248
Filters based on the amplitude of the first derivative

src/gsd.js

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,6 @@ import SG from 'ml-savitzky-golay-generalized';
1717
* @param {boolean} [options.realTopDetection = false] - Use a quadratic optimizations with the peak and its 3 closest neighbors
1818
* to determine the true x,y values of the peak?
1919
* @param {number} [options.heightFactor = 0] - Factor to multiply the calculated height (usually 2)
20-
* @param {boolean} [options.boundaries = false] - Return also the inflection points of the peaks
2120
* @param {number} [options.derivativeThreshold = -1] - Filters based on the amplitude of the first derivative
2221
* @return {Array<object>}
2322
*/

0 commit comments

Comments
 (0)